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
Metadata
Release files for polyaxon-client 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| polyaxon-client-0.6.1.tar.gz | 52.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| polyaxon_client-0.6.1-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 140.1 kB
Release files / polyaxon-client-0.6.1.tar.gz
| Download URL | polyaxon-client-0.6.1.tar.gz |
|---|---|
| Size | 52.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9bc49ef580596b3c9de57c8f6d4bfba425ffdbe5eab8b6e740975a9fad9ea478
|
|
BLAKE2b-256 checksum How to use checksums |
27c0c013fb5b5a1401d5e5fcb90e216b6b7d71d34c74373760b24654b40d4e9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1
|
Release files / polyaxon_client-0.6.1-py2.py3-none-any.whl
| Download URL | polyaxon_client-0.6.1-py2.py3-none-any.whl |
|---|---|
| Size | 87.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
878cab1c4bdf9af5ef6c11e5f76ceffc6877ccf2de8687532b4159f38424e5f3
|
|
BLAKE2b-256 checksum How to use checksums |
b562d499b85386e9e06110dcc39c83e9f55e9c3da399ab34a9ad61a27aa460cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1
|