Metadata-Version: 1.2
Name: cumulator
Version: 0.0.2
Summary: a tool to quantify and communicate the carbon footprint of computations
Home-page: https://github.com/tristantreb/cumulator
Author: tristan trebaol
Author-email: tristan.trebaol@epfl.ch
License: MIT
Project-URL: Documentation, https://cumulator.readthedocs.io/
Project-URL: Changelog, https://cumulator.readthedocs.io/en/latest/changelog.html
Project-URL: Issue Tracker, https://github.com/tristantreb/cumulator/issues
Description: ========
        Overview
        ========
        
        An API to evaluate the carbon footprint of computation and communcation of machine learning methods (or any other computing system).
        
        
        Background
        __________
        Current researchers produce methods and tools to evaluate and optimize the efficiency (from both time and spatial scales) of large-scale ML computations.
        
        Aim
        ___
        Raise awareness about the carbon footprint of machine learning methods and to encourage further optimization and the rationale use of AI-powered tools
        
        Method
        ______
        Create Cumulator, a simple API to evaluate the carbon footprint of communication and computation of a machine learning models which provides effortless integration within any python framework.
        
        * Free software: MIT license
        
        Installation
        ============
        
        Use the following command:
        
            pip install cumulator
        
        
        Functionalities
        ===============
        At the moment Cumulator has the following functionalities: 
        
        * Chronometer activation and deactivation
        * Time aggregation (cumulative time of activation/deactivation) per instance of the cumulator class
        * Display of the carbon footprint
        
        Hence, to compare n different network topologies, one can create n cumulator instance and display the relative carbon footprint after computation.
        
        Use cases
        =========
        Cumulator was integrated within the Alg-E platform
        
        ChangeLog
        =========
        * 07.06.2020: 0.0.2 added communication costs and cleaned src/
        * 21.05.2020: 0.0.1 deployment on PypI and integration with Alg-E
        
        Links
        =====
        * GitHub: https://github.com/tristantreb/cumulator
        * PyPI: https://pypi.org/project/cumulator/
        
        
        Changelog
        =========
        
        0.0.0 (2020-05-14)
        ------------------
        
        * First release on PyPI.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
