Metadata-Version: 2.1
Name: optscale_arcee
Version: 0.1.34
Summary: ML profiling tool for OptScale
Home-page: https://my.optscale.com/
Author: Hystax
License: UNKNOWN
Description: # Arcee
        ## *The OptScale ML profiling tool by Hystax*
        
        Arcee is a tool that hepls you to integrate ML tasks with [OptScale](https://my.optscale.com/).
        This tool can automatically collect executor metadata from cloud and process stats.
        
        ## Installation
        Arcee requires python 3.7+ to run.
        ```sh
        pip install optscale-arcee
        ```
        
        ## Usage
        First of all you need to import and init arcee in your code:
        ```sh
        import optscale_arcee as arcee
        ```
        
        ```sh
        # init arcee using context manager syntax
        with arcee.init('token', 'model_key'):
            # some code
        ```
        
        To use custom endpoint and enable\disable ssl checks (supports using self-signed ssl certificates):
        ```sh
        with arcee.init('token', 'model_key', endpoint_url='https://my.custom.endpoint:443/arcee/v2', ssl=False):
            # some code
        ```
        
        Alternatively arcee can be initialized via function call. However manual finish is required:
        ```sh
        arcee.init('token', 'model_key')
        # some code
        arcee.finish()
        ```
        
        Or in error case:
        ```sh
        arcee.init('token', 'model_key')
        # some code
        arcee.error()
        ```
        
        To send stats:
        ```sh
        arcee.send({"loss": 2.0012, "iter": 2, "epoch": 1})
        ```
        (key should be string, value - int or float, multiple values can be sent)
        
        To add tags to model run (key, value):
        ```sh
        arcee.tag("project", "torchvision demo")
        ```
        
        To add milestones:
        ```sh
        arcee.milestone("Download test data")
        ```
        
        To add stages:
        ```sh
        arcee.stage("calculation")
        ```
        
Keywords: arcee,ml,optscale,finops,mlops
Platform: UNKNOWN
Requires-Python: <4,>=3.7
Description-Content-Type: text/markdown
