Python client to interact with Polyaxon API.
Project description
polyaxon-client
Python clients to interact with Polyaxon API.
Install
$ pip install -U polyaxon-client
Clients
This module includes a client that can be used to interact with Polyaxon API in a programmatic way.
- Auth: A client for handling authentication and user information.
- Cluster: A client for getting cluster and cluster nodes information.
- User: A client to manage users and superuser roles.
- Project: A client for doing CRUD operations on projects, as well as getting and creating experiments and experiment groups, creating and stopping tensorboard/notebook, and uploading code.
- Experiment: A client for doing CRUD operations on experiments, as well as statuses, jobs, resources, and logs.
- Experiment group: A client for doing CRUD operations on experiment groups, as well as fetching experiments per group.
- Experiment Job: A client for getting information, resources, and logs of experiment jobs.
- Job: A client for getting information, resources, and logs of jobs.
- Build Job: A client for getting information, resources, and logs of build jobs.
- Bookmark: A client for getting bookmarks.
- Version: A client to get current and supported versions of several Polyaxon component.
Usage
from polyaxon_client import PolyaxonClient
polyaxon_client = PolyaxonClient(
host=POLYAXON_IP,
token=MY_TOKEN, http_port=POLYAXON_HTTP_PORT,
ws_port=POLYAXON_WS_PORT)
polyaxon_client.auth
polyaxon_client.cluster
polyaxon_client.user
polyaxon_client.project
polyaxon_client.experiment
polyaxon_client.experiment_group
polyaxon_client.experiment_job
polyaxon_client.job
polyaxon_client.build_job
polyaxon_client.bookmark
polyaxon_client.version
e.g. list projects for a user
polyaxon_client.project.list_projects(username, page=1)
e.g. list experiments for a project
polyaxon_client.project.list_experiments(
username,
project_name,
independent=None,
group=None,
metrics=None,
params=None,
query=None,
sort=None,
page=1)
Install polyaxon
Please check polyaxon installation guide
Quick start
Please check our quick start guide to start training your first experiment.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
polyaxon-client-0.5.2.tar.gz
(52.0 kB
view hashes)
Built Distribution
Close
Hashes for polyaxon_client-0.5.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0b295ab4f4982b9537adf01bf2dff45a27eca6ef6bf465e011feb9f13092461 |
|
MD5 | c6ab8b0090f413496450e723c110e2e6 |
|
BLAKE2b-256 | de827282752c82e1fa845a6f456163204391da8291edb452c52a5a8243bd9ba2 |