Metadata-Version: 2.1
Name: fastpipeline
Version: 0.0.1
Summary: Build time saving ML pipelines with built in autosave and reload
Home-page: https://github.com/shashank-yadav/fastpipeline
Author: Shashank Yadav
Author-email: shashank7.iitd@gmail.com
License: UNKNOWN
Description: # FastPipeline
        
        <p align="center">
            <em>Persistent, easy to use, fast to code
        </em>
        </p>
        
        ---
        
        **Documentation**: <a href="https://shashank-yadav.github.io/fastpipeline" target="_blank">https://shashank-yadav.github.io/fastpipeline/</a>
        
        **Source Code**: <a href="https://github.com/shashank-yadav/fastpipeline" target="_blank">https://github.com/shashank-yadav/fastpipeline</a>
        
        ---
        
        FastPipeline is a framework for creating general purpose pipeline in your ML projects. It helps in keeping track of your experiments by automatically storing all the intermediate data and source code. 
        
        The key features are:
        
        * **Persistence**: Automatically stores all the intermediate data and variables during the run.
        * **Autoreload**: Detects if something has been computed before and reloads it instead of a do-over.
        * **Accessible Intermediate Data**: The intermediate data is stored as pickle and json files, can be easily accessed and analyzed.
        * **General Purpose**: Unlike sklearn pipelines you don't need to format your data into the required X, y format.
        * **Intuitive**: Great editor support. <abbr title="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr> everywhere. Less time debugging.
        * **Easy**: Designed to be easy to use and learn. Less time reading docs.
        
        ## Installation
        
        <div class="termy">
        
        ```console
        $ pip install fastpipeline
        
        ---> 100%
        ```
        
        </div>
        
        ## Example
        
        #### Train a classifier over the (in)famous MNIST dataset
        
        * Create a file `mnist_pipeline.py`
        * Make necessary imports and create a class `DataLoader` that extends the `BaseNode` class from the fastpipeline package. This is something we'll refer to as a `Node`
        
        ```Python
        # Import datasets, classifiers and performance metrics
        from sklearn import datasets, svm, metrics
        from sklearn.model_selection import train_test_split
        import numpy as np
        
        # Import pipeline and node constructs
        from fastpipeline.base_node import BaseNode
        from fastpipeline.pipeline import Pipeline
        
        # Node for loading data
        class DataLoader(BaseNode):
            def __init__(self):
                super().__init__()
            
            def run(self, input = {}):
                # The digits dataset
                digits = datasets.load_digits()
        
                # To apply a classifier on this data, we need to flatten the image, to
                # turn the data in a (samples, feature) matrix:
                n_samples = len(digits.images)
                data = digits.images.reshape((n_samples, -1))
                return {
                    'data': data,
                    'target': digits.target
                }
        ```
        
        * Create another `Node` whose input is output of `DataLoader` and that trains an SVM classifier
        ```Python
        # Node for training the classifier
        class SVMClassifier(BaseNode):
            def __init__(self, config):
                super().__init__(config)
                gamma = config['gamma']
                # Create a classifier: a support vector classifier
                self.classifier = svm.SVC(gamma=gamma)
            
            def run(self, input):
                data = input['data']
                target = input['target']
        
                # Split data into train and test subsets
                X_train, X_test, y_train, y_test = train_test_split(
                    data, target, test_size=0.5, shuffle=False)
        
                # We learn the digits on the first half of the digits
                self.classifier.fit(X_train, y_train)
        
                # Now predict the value of the digit on the second half:
                y_pred = self.classifier.predict(X_test)
        
                return {
                    'acc': np.mean(y_test == y_pred),
                    'y_test': y_test,
                    'y_pred': y_pred 
                }
        ```
        * Now let's instantiate the nodes and create our pipeline
        ```Python
        if __name__ == "__main__":
            # Initialize the nodes
            dl_node = DataLoader()
            svm_node = SVMClassifier({'gamma': 0.01})
            
            # Create the pipeline
            pipeline = Pipeline('mnist', [dl_node, svm_node])
        
            # Run pipeline and see results
            result = pipeline.run(input={})
            print('Accuracy: %s'%result['acc'])
        
        ```
        * Run the pipeline using `$ python mnist.py`. You should see somthing like:
        
        
        ![Screenshot](/docs/img/fastpipeline_mnist1.jpg)
        
        As expected it says that this is the first run and hence for both nodes outputs are being computed by calling their `run` method. The log here shows where the data is being stored
        
        * Try running it again with the same command: `$ python mnist.py`. This time you should see something different:
        
        
        ![Screenshot](/docs/img/fastpipeline_mnist2.jpg)
        
        Since all the intermediate outputs are already computed, the pipeline just reloads the data at each step instead of re-computing
        
        * Let's make a change to the value of config inside `__main__`:
        ```Python
        # svm_node = SVMClassifier({'gamma': 0.01})
        svm_node = SVMClassifier({'gamma': 0.05})
        ```
        * Run the pipeline again. You'll see something like:
        
        
        ![Screenshot](/docs/img/fastpipeline_mnist3.jpg)
        
        This time it used the result from first node as-is and recomputed for second node, since we made a change to the config. 
        
        **If you make any changes to the class `SVMClassifier` same thing will happen again.**
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7.4
Description-Content-Type: text/markdown
