Metadata-Version: 2.1
Name: ml-report
Version: 0.0.2
Summary: Automated reporting for training and evaluating Machine Learning models
Home-page: https://github.com/wally-wissner/ml_report
Author: Wally Wissner
Author-email: wally.wissner.MS@gmail.com
License: MIT License        
        Copyright (c) 2021 Wally Wissner        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.        
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: OS Independent
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: eli5 (>=0.11.0)
Requires-Dist: dill (>=0.3.3)
Requires-Dist: joblib (>=1.0.1)
Requires-Dist: nltk (>=3.4)
Requires-Dist: numpy (>=1.18.2)
Requires-Dist: pandas (>=0.25.0)
Requires-Dist: scikit-learn (>=0.24.1)
Requires-Dist: tqdm (>=4.28.1)
Provides-Extra: dev
Requires-Dist: pytest (>=3.7) ; extra == 'dev'

# Purpose

**ml-report** is a Python module providing in-depth metrics and diagnostics for training and evaluating Machine Learning models.


# Installation

    pip install ml-report


# Usage

**ml-report** is designed to be powerful yet lightweight. 

    from ml_report import Report
    report = Report(...)
    report.fit(X, y)
    report.build_report()


