Skip to content
Python toolkit to help developers test their models against the COMP interface
Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Compute Studio Kit

cs-kit tests your model's functions against the Compute Studio criteria. If your functions pass the cs-kit tests, then you can be reasonably sure that the functions will work on

Compute Studio Kit also provides a helper command for retrieving your Compute Studio API token.

Install cs-kit

pip install cs-kit

Set up the cs-config directory

$ csk-init
$ tree cs-config/
├── cs_config
│   ├──
│   ├──
│   └── tests
│       ├──
│       └──

Write your functions in cs-config/cs_config/

# Write or import your Compute Studio functions here.

def get_version():

def get_inputs(meta_param_dict):

def validate_inputs(meta_param_dict, adjustment, errors_warnings):

def run_model(meta_param_dict, adjustment):

Test your functions in cs-config/cs_config/tests/

from cs_kit import CoreTestFunctions

from cs_config import functions

class TestFunctions1(CoreTestFunctions):
    get_version = functions.get_version
    get_inputs = functions.get_inputs
    validate_inputs = functions.validate_inputs
    run_model = functions.run_model
    ok_adjustment={"matchup": {"pitcher": [{"value": "Max Scherzer"}]}}
    bad_adjustment={"matchup": {"pitcher": [{"value": "Not a pitcher"}]}}

Run your cs-config tests

py.test cs-config

Write your installation instructions in cs-config/

conda install your-project

Get your Compute Studio API token

$ csk-token --username myuser --password mypass
Token: your-token-here

Run the compute-studio-kit tests

py.test cs_kit -v
You can’t perform that action at this time.