[](LICENSE)
[](https://travis-ci.org/polyaxon/polyaxon-client)
[](https://badge.fury.io/py/polyaxon-client)
[](https://www.codacy.com/app/polyaxon/polyaxon-client?utm_source=github.com&utm_medium=referral&utm_content=polyaxon/polyaxon-client&utm_campaign=Badge_Grade)
[](https://join.slack.com/t/polyaxon/shared_invite/enQtMzQ0ODc2MDg1ODc0LWY2ZTdkMTNmZjBlZmRmNjQxYmYwMTBiMDZiMWJhODI2ZTk0MDU4Mjg5YzA5M2NhYzc5ZjhiMjczMDllYmQ2MDg)
# polyaxon-client
Python clients to interact with Polyaxon API.
## Install
```bash
$ 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](https://docs.polyaxon.com/references/polyaxon-client-python/auth): A client for handling authentication and user information.
* [Cluster](https://docs.polyaxon.com/references/polyaxon-client-python/cluster): A client for getting cluster and cluster nodes information.
* [User](https://docs.polyaxon.com/references/polyaxon-client-python/user): A client to manage users and superuser roles.
* [Project](https://docs.polyaxon.com/references/polyaxon-client-python/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](https://docs.polyaxon.com/references/polyaxon-client-python/experiment): A client for doing CRUD operations on experiments, as well as statuses, jobs, resources, and logs.
* [Experiment group](https://docs.polyaxon.com/references/polyaxon-client-python/experiment-group): A client for doing CRUD operations on experiment groups, as well as fetching experiments per group.
* [Experiment Job](https://docs.polyaxon.com/references/polyaxon-client-python/experiment-job): A client for getting information, resources, and logs of experiment jobs.
* [Job](https://docs.polyaxon.com/references/polyaxon-client-python/job): A client for getting information, resources, and logs of jobs.
* [Build Job](https://docs.polyaxon.com/references/polyaxon-client-python/build-job): A client for getting information, resources, and logs of build jobs.
* [Bookmark](https://docs.polyaxon.com/references/polyaxon-client-python/bookmark): A client for getting bookmarks.
* [Version](https://docs.polyaxon.com/references/polyaxon-client-python/version): A client to get current and supported versions of several Polyaxon component.
## Usage
```python
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
```python
polyaxon_client.project.list_projects(username, page=1)
```
e.g. list experiments for a project
```python
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](https://docs.polyaxon.com/setup/)
## Quick start
Please check our [quick start guide](https://docs.polyaxon.com/concepts/quick-start/) to start training your first experiment.
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fpolyaxon%2Fpolyaxon-client?ref=badge_large)
Raw data
{
"_id": null,
"home_page": "https://github.com/polyaxon/polyaxon-client",
"name": "polyaxon-client",
"maintainer": "Mourad Mourafiq",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"maintainer_email": "mourad@polyaxon.com",
"keywords": "polyaxon,aws,s3,microsoft,azure,google cloud storage,gcs,tensorFlow,deep-learning,machine-learning,data-science,neural-networks,artificial-intelligence,ai,reinforcement-learning,kubernetes",
"author": "Mourad Mourafiq",
"author_email": "mourad@polyaxon.com",
"download_url": "https://files.pythonhosted.org/packages/27/c0/c013fb5b5a1401d5e5fcb90e216b6b7d71d34c74373760b24654b40d4e9c/polyaxon-client-0.6.1.tar.gz",
"platform": "any",
"description": "[](LICENSE)\n[](https://travis-ci.org/polyaxon/polyaxon-client)\n[](https://badge.fury.io/py/polyaxon-client)\n[](https://www.codacy.com/app/polyaxon/polyaxon-client?utm_source=github.com&utm_medium=referral&utm_content=polyaxon/polyaxon-client&utm_campaign=Badge_Grade)\n[](https://join.slack.com/t/polyaxon/shared_invite/enQtMzQ0ODc2MDg1ODc0LWY2ZTdkMTNmZjBlZmRmNjQxYmYwMTBiMDZiMWJhODI2ZTk0MDU4Mjg5YzA5M2NhYzc5ZjhiMjczMDllYmQ2MDg)\n\n\n# polyaxon-client\n\nPython clients to interact with Polyaxon API.\n\n\n## Install\n\n```bash\n$ pip install -U polyaxon-client\n```\n\n## Clients\n\nThis module includes a client that can be used to interact\nwith Polyaxon API in a programmatic way.\n\n * [Auth](https://docs.polyaxon.com/references/polyaxon-client-python/auth): A client for handling authentication and user information.\n * [Cluster](https://docs.polyaxon.com/references/polyaxon-client-python/cluster): A client for getting cluster and cluster nodes information.\n * [User](https://docs.polyaxon.com/references/polyaxon-client-python/user): A client to manage users and superuser roles.\n * [Project](https://docs.polyaxon.com/references/polyaxon-client-python/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.\n * [Experiment](https://docs.polyaxon.com/references/polyaxon-client-python/experiment): A client for doing CRUD operations on experiments, as well as statuses, jobs, resources, and logs.\n * [Experiment group](https://docs.polyaxon.com/references/polyaxon-client-python/experiment-group): A client for doing CRUD operations on experiment groups, as well as fetching experiments per group.\n * [Experiment Job](https://docs.polyaxon.com/references/polyaxon-client-python/experiment-job): A client for getting information, resources, and logs of experiment jobs.\n * [Job](https://docs.polyaxon.com/references/polyaxon-client-python/job): A client for getting information, resources, and logs of jobs.\n * [Build Job](https://docs.polyaxon.com/references/polyaxon-client-python/build-job): A client for getting information, resources, and logs of build jobs.\n * [Bookmark](https://docs.polyaxon.com/references/polyaxon-client-python/bookmark): A client for getting bookmarks.\n * [Version](https://docs.polyaxon.com/references/polyaxon-client-python/version): A client to get current and supported versions of several Polyaxon component.\n\n\n## Usage\n\n```python\nfrom polyaxon_client import PolyaxonClient\n\npolyaxon_client = PolyaxonClient(\n host=POLYAXON_IP,\n token=MY_TOKEN, http_port=POLYAXON_HTTP_PORT,\n ws_port=POLYAXON_WS_PORT)\n\npolyaxon_client.auth\npolyaxon_client.cluster\npolyaxon_client.user\npolyaxon_client.project\npolyaxon_client.experiment\npolyaxon_client.experiment_group\npolyaxon_client.experiment_job\npolyaxon_client.job\npolyaxon_client.build_job\npolyaxon_client.bookmark\npolyaxon_client.version\n```\n\ne.g. list projects for a user\n\n```python\npolyaxon_client.project.list_projects(username, page=1)\n```\n\ne.g. list experiments for a project\n\n```python\npolyaxon_client.project.list_experiments(\n username,\n project_name,\n independent=None,\n group=None,\n metrics=None,\n params=None,\n query=None,\n sort=None,\n page=1)\n```\n\n\n## Install polyaxon\n\nPlease check [polyaxon installation guide](https://docs.polyaxon.com/setup/)\n\n\n## Quick start\n\nPlease check our [quick start guide](https://docs.polyaxon.com/concepts/quick-start/) to start training your first experiment.\n\n\n## License\n\n[](https://app.fossa.io/projects/git%2Bgithub.com%2Fpolyaxon%2Fpolyaxon-client?ref=badge_large)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client to interact with Polyaxon API.",
"version": "0.6.1",
"split_keywords": [
"polyaxon",
"aws",
"s3",
"microsoft",
"azure",
"google cloud storage",
"gcs",
"tensorflow",
"deep-learning",
"machine-learning",
"data-science",
"neural-networks",
"artificial-intelligence",
"ai",
"reinforcement-learning",
"kubernetes"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "92d72346933beb441c4b3176d173c3d8",
"sha256": "878cab1c4bdf9af5ef6c11e5f76ceffc6877ccf2de8687532b4159f38424e5f3"
},
"downloads": -1,
"filename": "polyaxon_client-0.6.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "92d72346933beb441c4b3176d173c3d8",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 87773,
"upload_time": "2020-03-04T09:34:40",
"upload_time_iso_8601": "2020-03-04T09:34:40.290645Z",
"url": "https://files.pythonhosted.org/packages/b5/62/d499b85386e9e06110dcc39c83e9f55e9c3da399ab34a9ad61a27aa460cd/polyaxon_client-0.6.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "061e35958f772e5e8633315669ede1cd",
"sha256": "9bc49ef580596b3c9de57c8f6d4bfba425ffdbe5eab8b6e740975a9fad9ea478"
},
"downloads": -1,
"filename": "polyaxon-client-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "061e35958f772e5e8633315669ede1cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 52292,
"upload_time": "2020-03-04T09:34:41",
"upload_time_iso_8601": "2020-03-04T09:34:41.998788Z",
"url": "https://files.pythonhosted.org/packages/27/c0/c013fb5b5a1401d5e5fcb90e216b6b7d71d34c74373760b24654b40d4e9c/polyaxon-client-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-03-04 09:34:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "polyaxon",
"github_project": "polyaxon-client",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "polyaxon-client"
}
JSON
