Metadata-Version: 1.0
Name: memory_profiler
Version: 0.2
Summary: A module for getting memory usage of a python program
Home-page: http://pypi.python.org/pypi/memory_profiler
Author: Fabian Pedregosa
Author-email: fabian@fseoane.net
License: UNKNOWN
Description: Memory Profiler
        ---------------
        This is a python module for monitoring memory consumption of a process
        as well as line-by-line analysis of memory consumption for python
        programs.
        
        
        Installation
        ------------
        To install through easy_install or pip::
        
            $ easy_install -U line_profiler # pip install -U line_profiler
        
        To install from source, download the package, extract and type::
        
            $ python setup.py install
        
        
        
        Usage
        -----
        The line-by-line profiler is used much in the same way of the
        line_profiler: you must first decorate the function you would like to
        profile with @profile::
        
            @profile
            def my_func():
                a = np.zeros((100, 100))
                b = np.zeros((1000, 1000))
                c = np.zeros((10000, 1000))
                return a, b, c
        
        
        then execute the code passing the option "-m memory_profiler" to the
        python interpreter. If the file name was example.py, this would result
        in::
        
            $ python -m line_profiler example.py
        
        Output will follow::
        
            Line #    Mem usage   Line Contents
            ===================================
                 3                @profile
                 4                def my_func():
                 5     13.68 MB       a = np.zeros((100, 100))
                 6     13.77 MB       b = np.zeros((1000, 1000))
                 7     21.40 MB       c = np.zeros((10000, 1000))
                 8     97.70 MB       return a, b, c
        
        
        
        Bugs & wishlist
        ---------------
        It currently prints the memory at line *before* the line has been
        executed. It would be nice to print consumption after the line has
        been executed. Maybe also print the increment in memory consumption.
        
        
        Development
        -----------
        Latest sources are available from github:
        
            https://github.com/fabianp/memory_profiler
        
        
        Author: Fabian Pedregosa <fabian@fseoane.net>
        License: Simplified BSD
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
