Metadata-Version: 1.1
Name: cloudml-hypertune
Version: 0.1.0.dev6
Summary: A library to report Google CloudML Engine HyperTune metrics.
Home-page: http://github.com/GoogleCloudPlatform/cloudml-hypertune
Author: Google CloudML Engine
Author-email: cloudml-feedback@google.com
License: Apache Software License
Description: Metric Reporting Python Package for CloudML Hypertune
        =====================================================
            Helper Functions for CloudML Engine Hypertune Services.
        
        .. _Google CloudML Engine Hyperparameter Tuning Service: https://cloud.google.com/ml-engine/docs/tensorflow/hyperparameter-tuning-overview
        
        |pypi| |versions|
        
        Prerequisites
        -------------
        
        -  Google CloudML Engine `Overview <https://cloud.google.com/ml-engine/>`__.
        
        -  Google CloudML Engine `Hyperparameter Tuning
           Overview <https://cloud.google.com/ml-engine/docs/tensorflow/hyperparameter-tuning-overview>`__.
        
        Installation
        ------------
        Install via `pip <https://pypi.python.org/pypi/pip>`__:
        
        ::
        
            pip install cloudml-hypertune
        
        Usage
        -----
        
        .. code:: python
        
            import hypertune
        
            hpt = hypertune.HyperTune()
            hpt.report_hyperparameter_tuning_metric(
                hyperparameter_metric_tag='my_metric_tag',
                metric_value=0.987,
                global_step=1000)
        
        By default, the metric entries will be stored to ``/tmp/hypertune/outout.metric`` in json format:
        
        ::
        
            {"global_step": "1000", "my_metric_tag": "0.987", "timestamp": 1525851440.123456, "trial": "0"}
        
        Licensing
        ---------
        
        - Apache 2.0
        
        .. |pypi| image:: https://img.shields.io/pypi/v/cloudml-hypertune.svg
           :target: https://pypi.org/project/cloudml-hypertune/
        .. |versions| image:: https://img.shields.io/pypi/pyversions/cloudml-hypertune.svg
           :target: https://pypi.org/project/cloudml-hypertune/
        
Keywords: ml hyperparameter tuning
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Distributed Computing
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
