Metadata-Version: 2.1
Name: sanitize_ml_labels
Version: 1.0.2
Summary: Simple python package to sanitize in a standard way ML-related labels.
Home-page: https://github.com/LucaCappelletti94/sanitize_ml_labels
Author: Luca Cappelletti
Author-email: cappelletti.luca94@gmail.com
License: MIT
Description: sanitize_ml_labels
        =========================================================================================
        |travis| |sonar_quality| |sonar_maintainability| |codacy| |code_climate_maintainability| |pip| |downloads|
        
        Simple python package to sanitize in a standard way ML-related labels.
        
        How do I install this package?
        ----------------------------------------------
        As usual, just download it using pip:
        
        .. code:: shell
        
            pip install sanitize_ml_labels
        
        Tests Coverage
        ----------------------------------------------
        Since some software handling coverages sometime get slightly different results, here's three of them:
        
        |coveralls| |sonar_coverage| |code_climate_coverage|
        
        Usage examples
        ----------------------------------------------
        So you have some kind of plot and you have some ML-related labels.
        Since I always rename and sanitize them the same way, I have prepared
        this package to always sanitize them in a standard fashion.
        
        .. code:: python
        
            from sanitize_ml_labels import sanitize_ml_labels
        
            # Example for metrics
            labels = [
                "acc",
                "loss",
                "auroc",
                "lr"
            ]
        
            sanitize_ml_labels(labels)
        
            # ["Accuracy", "Loss", "AUROC", "Learning rate"]
        
            # Example for models
            labels = [
                "vanilla mlp",
                "vanilla cnn",
                "vanilla ffnn",
                "vanilla perceptron"
            ]
        
            sanitize_ml_labels(labels)
        
            # ["MLP", "CNN", "FFNN", "Perceptron"]
        
        
        New features and issues
        -----------------------
        As always, for new features and issues you can either open a new issue and pull request.
        A pull request will always be the quicker way, but I'll look into the issues when I get the time.
        
        .. |travis| image:: https://travis-ci.org/LucaCappelletti94/sanitize_ml_labels.png
           :target: https://travis-ci.org/LucaCappelletti94/sanitize_ml_labels
           :alt: Travis CI build
        
        .. |sonar_quality| image:: https://sonarcloud.io/api/project_badges/measure?project=LucaCappelletti94_sanitize_ml_labels&metric=alert_status
            :target: https://sonarcloud.io/dashboard/index/LucaCappelletti94_sanitize_ml_labels
            :alt: SonarCloud Quality
        
        .. |sonar_maintainability| image:: https://sonarcloud.io/api/project_badges/measure?project=LucaCappelletti94_sanitize_ml_labels&metric=sqale_rating
            :target: https://sonarcloud.io/dashboard/index/LucaCappelletti94_sanitize_ml_labels
            :alt: SonarCloud Maintainability
        
        .. |sonar_coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=LucaCappelletti94_sanitize_ml_labels&metric=coverage
            :target: https://sonarcloud.io/dashboard/index/LucaCappelletti94_sanitize_ml_labels
            :alt: SonarCloud Coverage
        
        .. |coveralls| image:: https://coveralls.io/repos/github/LucaCappelletti94/sanitize_ml_labels/badge.svg?branch=master
            :target: https://coveralls.io/github/LucaCappelletti94/sanitize_ml_labels?branch=master
            :alt: Coveralls Coverage
        
        .. |pip| image:: https://badge.fury.io/py/sanitize-ml-labels.svg
            :target: https://badge.fury.io/py/sanitize-ml-labels
            :alt: Pypi project
        
        .. |downloads| image:: https://pepy.tech/badge/sanitize-ml-labels
            :target: https://pepy.tech/badge/sanitize-ml-labels
            :alt: Pypi total project downloads 
        
        .. |codacy|  image:: https://api.codacy.com/project/badge/Grade/a60602ff54ac443fbc4aa3d016dbda48
            :target: https://www.codacy.com/manual/LucaCappelletti94/sanitize_ml_labels?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=LucaCappelletti94/sanitize_ml_labels&amp;utm_campaign=Badge_Grade
            :alt: Codacy Maintainability
        
        .. |code_climate_maintainability| image:: https://api.codeclimate.com/v1/badges/042f787897c13cb78ddf/maintainability
            :target: https://codeclimate.com/github/LucaCappelletti94/sanitize_ml_labels/maintainability
            :alt: Maintainability
        
        .. |code_climate_coverage| image:: https://api.codeclimate.com/v1/badges/042f787897c13cb78ddf/test_coverage
            :target: https://codeclimate.com/github/LucaCappelletti94/sanitize_ml_labels/test_coverage
            :alt: Code Climate Coverate
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Provides-Extra: test
