PipeRider Python SDK
Project description
PipeRider SDK For Python
The PipeRiper SDK for Python enables you to access and manipulate project resources in your PipeRider account.
Installation
pip install piperider-python-sdk
Configuration
To use the SDK you will need to obtain an API key. This can be done from the User Settings page of your account.
https://app.piperider.io/settings
Configure your API key using one of the following methods.
Store API key in an environment variable
Users can set the API key as an environment variable.
export PIPERIDER_API_KEY=<user_api_key>
Configure API key using the set_api_key function
Set your API key using the set_api_key
function.
import PipeRider
PipeRider.set_api_key('api-key')
Usage
Import the PipeRider module.
import PipeRider
Create a project.
project = PipeRider.create_project('my-project')
Use an existing project.
project = PipeRider.project_by_uid('6f9f6eb9-8657-4761-9e32-116f1b8cfb82')
Create a run and save the settings for a machine learning project.
with project.runs.create(name='Awesome Run') as run:
run.config = {
'learning_rate': 0.02,
'architecture': 'CNN',
'dataset': 'TKNV-users',
}
run.params = {
'batch_size': 64,
'epoch': 100,
'learning_rate': 0.005
}
Add a dataset. This will enable you to more easily trace your model lineage.
run.add_dataset('golden-dataset')
Comments can also be added to the timeline.
project.comment('it is a good idea.')
If the run achieves the desired performance it can be registered as a model by declaring it a win
.
run.win()
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for piperider-python-sdk-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3297c46a0ddd64823624c9db745ce3ada12f10427de49b005e07166b917d0d76 |
|
MD5 | 0ac0eed7ee5b9353b74d8684bf7804a9 |
|
BLAKE2b-256 | b19fdd61de70a552f30144b15f59e45e20e1661425f62a509bc525dd4a6170d6 |
Hashes for piperider_python_sdk-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf502075ca3da44eaade2d20ce858179dc3a3120560ec075c6a2a884d6f6afe3 |
|
MD5 | 184a0d86fcf3a14074f4ef0a356b520d |
|
BLAKE2b-256 | f216973e9a2c860ef5ead2becc7da242e6056348e6b5e9bba9a8932b643ca211 |