Metadata-Version: 2.1
Name: memprofiler
Version: 0.1.8
Summary: A simple IPython extension for monitoring memory usage of Jupyter notebook cells.
Home-page: https://github.com/aleixalcacer/memprofiler
Author: Aleix Alcacer
Author-email: aleixalcacer@gmail.com
License: BSD (3-clause)
Description: # memprofiler
        
        ![PyPI](https://img.shields.io/pypi/v/memprofiler)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/memprofiler)
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/aleixalcacer/memprofiler/HEAD?filepath=examples/)
        
        memprofiler is a simple extension for monitoring memory usage of Jupyter notebook cells.
        
        
        ## Installation
        
        It can be installed as a typical Python source package from PyPi using pip:
        
        ```
        pip install memprofiler
        ```
        
        
        ## Usage
        
        A basic example of how to use this extension can be found in
        [this interactive Jupyter notebook](https://mybinder.org/v2/gh/aleixalcacer/memprofiler/HEAD?filepath=examples/basic.ipynb).
        
        
        ## Reference
        
        ### mprof_run
        
        *%mprof_run [-q] [-i INTERVAL] [-p] [profile_id]*
        
        Run memory profiler during cell execution. (*cell_magic*)
        
        - positional arguments:
            - *profile_id* \
                Profile label. You can specify up to two keywords by separating them
                with :: (`keyword0::keyword1`).
                Only profile_ids with two keywords can be used in plot-related
                functions.
        
        - optional arguments:
            - *-q*, *--quiet* \
                Suppress verbosity.
                
            - *-i INTERVAL*, *--interval INTERVAL* \
                Sampling period (in seconds), default 0.01.
              
            - *-p*, *--plot* \
                Plot the memory profile.
        
        
        ### mprof_plot
        
        *%mprof_plot [-t TITLE] [--groupby {0,1}] profile_ids [profile_ids ...]*
        
        Plot detailed memory profiler results. (*line_magic*)
        
        - positional arguments:
          
            - *profile_ids* \
                Profile identifiers made by mprof_run. Supports regex.
        
        - optional arguments:
          
            - *-t TITLE*, *--title TITLE* \
                String shown as plot title.
              
            - *--groupby <{0,1}>* \
                Identifier number used to group the results, default 1.
        
        
        ### mprof_barplot  
        
        *%mprof_barplot [-t TITLE] [--variable {time,memory}]
                             [--barmode {group,stack}] [--groupby {0,1}]
                             profile_ids [profile_ids ...]*
        
        Plot only-memory or only-time results in a bar chart. (*line_magic*)
        
        - positional arguments:
          
            - *profile_ids* \
                Profile labels made by mprof_run. Supports regex.
        
        - optional arguments:
          
            - *-t TITLE*, *--title TITLE* \
                String shown as plot title.
              
            - *--variable <{time,memory}>* \
                Variable to plot, default 'memory'.
          
            - *--barmode <{group,stack}>* \
                Bar char mode, default 'group'.
          
            - *--groupby <{0,1}>* \
                Identifier number used to group the results, default 1.
        
        ## Contributing
        
        Contributions are what make the open source community such an amazing place to be learn,
        inspire, and create. Any contributions you make are **greatly appreciated**!
        
        1. Fork the Project
        2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
        3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
        4. Push to the Branch (`git push origin feature/AmazingFeature`)
        5. Open a Pull Request
        
        
        ## License
        
        Distributed under the BSD 3-Clause License.
        See [LICENSE](https://github.com/aleixalcacer/memprofiler/blob/HEAD/LICENSE) for more information.
        
        
        ## Acknowledgements
        
        - [@FrancescAlted](https://github.com/FrancescAlted)
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.4
Description-Content-Type: text/markdown
