Introduction

Polyaxon client is python module that can be used to interact with Polyaxon API in a programmatic way.

Install

$ pip install -U polyaxon-client

for python3

$ pip3 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 group: A client for doing CRUD operations on experiment groups, as well as fetching experiments per group.
  • Experiment: A client for doing CRUD operations on experiments, as well as statuses, jobs, resources, and logs.
  • 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.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