Metadata-Version: 2.1
Name: dcyd
Version: 1.2.0
Summary: dcyd model performance monitoring client
Home-page: https://github.com/dcyd-inc/dcyd-mpm-client-python
Author: dcyd, inc.
Author-email: info@dcyd.io
License: UNKNOWN
Description: 
        # DCYD Model Performance Monitoring Client
        
        Visit https://www.dcyd.io/ for more details.
        
        ## Install
        
        Requires Python 3 before start
        
        ### Using pip
        
        ```
        pip3 install dcyd -U
        ```
        
        ### Using pipenv
        
        ```
        pipenv install dcyd
        ```
        
        
        ## Configure
        
        Generate the **dcyd.json** configuration file
        
        ```bash
        dcyd-config $DCYD_PROJECT_ID $DCYD_PROJECT_ACCESS_TOKEN
        ```
        
        Point the **DCYD_CONFIG_FILE** environment variable to the above file location
        
        ```bash
        export DCYD_CONFIG_FILE=/path/to/project/dcyd.json
        ```
        
        ## Usage
        
        ### Simple monitoring
        
        ```python
        from dcyd import dcyd
        
        @dcyd.monitor
        def my_predict_function(features):
            result = None
            # run my model(s) logic
            return result
        ```
        
        ### Transform function arguments before sending out
        
        ```python
        from dcyd import dcyd
        
        @dcyd.monitor(transformers={
            'arg1': lambda value: value + 1,
            'arg2': lambda value: value - 1,
            'arg3': lambda value: value * -1,
        })
        def my_predict_function(arg1, arg2=2, arg3=10):
            result = None
            # run my model(s) logic
            return result
        ```
        
        ### Transform function return value before sending out
        
        ```python
        from dcyd import dcyd
        
        @dcyd.dcyd.monitor(return_transformer=lambda value: value + 1)
        def my_predict_function():
            return 0
        ```
        
        
        ### Turn on writing data to a local file
        
        Set the environment variable `DCYD_CLIENT_FILE_LOGGER` with the file path you want to write to.
        
        An example is:
        
        ```
        export DCYD_CLIENT_FILE_LOGGER=/tmp/dcyd-client.log
        ```
        
        ### Disable sending data to DCYD
        
        Make sure the `dcyd.json` file is *absent* from your project directory.
        
        And make sure these environment variables are *absent* from the process. You can unset them by running the following:
        
        ```
        unset DCYD_CONFIG_FILE
        unset DCYD_PROJECT_ID
        unset DCYD_PROJECT_ACCESS_TOKEN
        ```
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
