gradient.api_sdk.models package

Submodules

gradient.api_sdk.models.artifact module

class gradient.api_sdk.models.artifact.Artifact(file: str, url: Optional[str] = None, size: Optional[int] = None)

Bases: object

__init__(file: str, url: Optional[str] = None, size: Optional[int] = None) → None

gradient.api_sdk.models.cluster module

class gradient.api_sdk.models.cluster.Cluster(id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None)

Bases: object

__init__(id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None) → None

gradient.api_sdk.models.dataset module

class gradient.api_sdk.models.dataset.Dataset(id: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, storage_provider_id: Optional[str] = None, storage_provider: gradient.api_sdk.models.storage_provider.StorageProvider = NOTHING)

Bases: object

Dataset class

__init__(id: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, storage_provider_id: Optional[str] = None, storage_provider: gradient.api_sdk.models.storage_provider.StorageProvider = NOTHING) → None
class gradient.api_sdk.models.dataset.DatasetRef(id: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, storage_provider_id: Optional[str] = None, storage_provider: gradient.api_sdk.models.storage_provider.StorageProvider = NOTHING, version: gradient.api_sdk.models.dataset_version.DatasetVersion = NOTHING)

Bases: gradient.api_sdk.models.dataset.Dataset

Dataset reference

__init__(id: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, storage_provider_id: Optional[str] = None, storage_provider: gradient.api_sdk.models.storage_provider.StorageProvider = NOTHING, version: gradient.api_sdk.models.dataset_version.DatasetVersion = NOTHING) → None

gradient.api_sdk.models.dataset_tag module

class gradient.api_sdk.models.dataset_tag.DatasetVersionSummary(version: Optional[str] = None, message: Optional[str] = None)

Bases: object

Dataset version summary class

__init__(version: Optional[str] = None, message: Optional[str] = None) → None
class gradient.api_sdk.models.dataset_tag.DatasetTag(name: Optional[str] = None, version: gradient.api_sdk.models.dataset_tag.DatasetVersionSummary = NOTHING)

Bases: object

Dataset version tag class

__init__(name: Optional[str] = None, version: gradient.api_sdk.models.dataset_tag.DatasetVersionSummary = NOTHING) → None

gradient.api_sdk.models.dataset_version module

class gradient.api_sdk.models.dataset_version.DatasetVersionTagSummary(name: Optional[str] = None)

Bases: object

Dataset version tag summary class

__init__(name: Optional[str] = None) → None
class gradient.api_sdk.models.dataset_version.DatasetVersion(version: Optional[str] = None, message: Optional[str] = None, is_committed: Optional[bool] = None, tags: list = NOTHING, dataset_id: Optional[str] = None)

Bases: object

Dataset version class

__init__(version: Optional[str] = None, message: Optional[str] = None, is_committed: Optional[bool] = None, tags: list = NOTHING, dataset_id: Optional[str] = None) → None
class gradient.api_sdk.models.dataset_version.DatasetVersionPreSignedS3Call(method: Optional[str] = None, params: dict = NOTHING)

Bases: object

Dataset version pre-signed S3 call class

__init__(method: Optional[str] = None, params: dict = NOTHING) → None
class gradient.api_sdk.models.dataset_version.DatasetVersionPreSignedURL(url: Optional[str] = None, expires_in: Optional[int] = None)

Bases: object

Dataset version pre-signed URL class

__init__(url: Optional[str] = None, expires_in: Optional[int] = None) → None

gradient.api_sdk.models.deployment module

class gradient.api_sdk.models.deployment.AutoscalingMetric(type: str, name: str, value_type: str, value: float)

Bases: object

__init__(type: str, name: str, value_type: str, value: float) → None
class gradient.api_sdk.models.deployment.AutoscalingDefinition(min_instance_count: Optional[int] = None, max_instance_count: Optional[int] = None, scale_cooldown_period: Optional[int] = None, metrics: list = NOTHING)

Bases: object

__init__(min_instance_count: Optional[int] = None, max_instance_count: Optional[int] = None, scale_cooldown_period: Optional[int] = None, metrics: list = NOTHING) → None
class gradient.api_sdk.models.deployment.Deployment(id: Optional[str] = None, name: Optional[str] = None, endpoint: Optional[str] = None, api_type: Optional[str] = None, state: Optional[str] = None, model_id: Optional[str] = None, project_id: Optional[str] = None, image_url: Optional[str] = None, deployment_type: Optional[str] = None, machine_type: Optional[str] = None, instance_count: Optional[int] = None, container_model_path: Optional[str] = None, image_username: Optional[str] = None, image_password: Optional[str] = None, image_server: Optional[str] = None, container_url_path: Optional[str] = None, endpoint_url_path: Optional[str] = None, method: Optional[str] = None, docker_args: Optional[list] = None, env: Optional[dict] = None, ports: Optional[str] = None, auth_username: Optional[str] = None, auth_password: Optional[str] = None, cluster_id: Optional[int] = None, tags: list = NOTHING, command: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, metrics_url: Optional[str] = None, autoscaling: Optional[gradient.api_sdk.models.deployment.AutoscalingDefinition] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None)

Bases: object

Deployment class

Deploy any model as a high-performance, low-latency micro-service with a RESTful API. Easily monitor, scale, and version deployments. Deployments take a trained model and expose them as a persistent service at a known, secure URL endpoint.

Parameters

  • id (str) – deployment id

  • name (str) – Human-friendly name for new model deployment

  • endpoint (str) –

    url address to deployment, for example:

    ``https://services.paperspace.io/model-serving/<your-model-id>:predict``

  • api_type (str) –

    api type of deployment Options:

    "GPRC"
"REST"

  • state (str) –

    state of Deployment Options:

    "BUILDING"
"PROVISIONING"
"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"ERROR"

  • model_id (str) – model id

  • project_id (str) – project id

  • image_url (str) – Docker image for model deployment

  • deployment_type (str) – Model deployment type.

  • machine_type (str) –

    Type of machine for new deployment Options:

    "G1"
"G6"
"G12"
"K80"
"P100"
"GV100"

  • instance_count (int) – Number of machine instances

__init__(id: Optional[str] = None, name: Optional[str] = None, endpoint: Optional[str] = None, api_type: Optional[str] = None, state: Optional[str] = None, model_id: Optional[str] = None, project_id: Optional[str] = None, image_url: Optional[str] = None, deployment_type: Optional[str] = None, machine_type: Optional[str] = None, instance_count: Optional[int] = None, container_model_path: Optional[str] = None, image_username: Optional[str] = None, image_password: Optional[str] = None, image_server: Optional[str] = None, container_url_path: Optional[str] = None, endpoint_url_path: Optional[str] = None, method: Optional[str] = None, docker_args: Optional[list] = None, env: Optional[dict] = None, ports: Optional[str] = None, auth_username: Optional[str] = None, auth_password: Optional[str] = None, cluster_id: Optional[int] = None, tags: list = NOTHING, command: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, metrics_url: Optional[str] = None, autoscaling: Optional[gradient.api_sdk.models.deployment.AutoscalingDefinition] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None) → None

gradient.api_sdk.models.experiment module

class gradient.api_sdk.models.experiment.BaseExperiment(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, is_preemptible: Optional[bool] = None, id: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None)

Bases: object

Base experiment class. Single node and multi node experiments classes inherit from it.

Experiments are intended to be used for intensive computational tasks like neural network training. Gradient supports single-node experiments as well as distributed training through multinode experiments.

Experiments can be run from the Experiment Builder web interface, the GradientCI bot, or the CLI.

Parameters

  • name (str) – Name of new experiment

  • ports (str) – Port to use in new experiment

  • workspace_url (str) – Project git repository url

  • workspace_ref (str) – Git commit hash, branch name or tag

  • workspace_username (str) – Project git repository username

  • workspace_password (str) – Project git repository password

:param Dataset dataset :param str working_directory: Working directory for the experiment :param str artifact_directory: Artifacts directory :param str cluster_id: Cluster ID (handle) :param dict experiment_env: Environment variables in a JSON :param str project_id: Project ID :param str model_type: defines the type of model that is being generated by the experiment. :param str model_path: Model path :param bool is_preemptible: Is preemptible :param str id: :param int state: state of experiment can be one of:

"created"
"provisioned"
"network setup"
"running"
"stopped"
"error"
"failed"
"canceled"
"network teardown"
"pending"
"provisioning"
"network setting up"
"network tearing down"
__init__(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, is_preemptible: Optional[bool] = None, id: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None) → None
class gradient.api_sdk.models.experiment.SingleNodeExperiment(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, is_preemptible: Optional[bool] = None, id: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None, container: Optional[str] = None, machine_type: Optional[str] = None, command: Optional[str] = None, container_user: Optional[str] = None, registry_username: Optional[str] = None, registry_password: Optional[str] = None, registry_url: Optional[str] = None, experiment_type_id: int = 1)

Bases: gradient.api_sdk.models.experiment.BaseExperiment

Single node experiment class. Inherits from BaseExperiment class

In your your CLI command or config.yaml, specify the experiment type as singlenode

Parameters

  • container (str) – Container (dockerfile)

  • machine_type (str) –

    Machine type Options:

    "Air"
"Standard"
"Pro"
"Advanced"
"GPU+"
"P4000"
"P5000"
"P6000"
"V100"
"C1"
"C2"
"C3"
"C4"
"C5"
"C6"
"C7"
"C8"
"C9"
"C10"

  • command (str) – Container entrypoint command

  • container_user (str) – Container user for running the specified command in the container. If no containerUser is specified, the user will default to ‘root’ in the container.

  • registry_username (str) – Registry username for accessing private docker registry container if nessesary

  • registry_password (str) – Registry password for accessing private docker registry container if nessesary

  • experiment_type_id (int) –

    type of experiment Options:

    "single node"
"GRPC multi node"
"MPI multi node"
"Hyperparameter tuning"

experiment_type_id_validator(attribute, value)
__init__(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, is_preemptible: Optional[bool] = None, id: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None, container: Optional[str] = None, machine_type: Optional[str] = None, command: Optional[str] = None, container_user: Optional[str] = None, registry_username: Optional[str] = None, registry_password: Optional[str] = None, registry_url: Optional[str] = None, experiment_type_id: int = 1) → None
class gradient.api_sdk.models.experiment.MultiNodeExperiment(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, is_preemptible: Optional[bool] = None, id: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None, experiment_type_id: Optional[int] = None, worker_container: Optional[str] = None, worker_machine_type: Optional[str] = None, worker_command: Optional[str] = None, worker_count: Optional[int] = None, parameter_server_container: Optional[str] = None, parameter_server_machine_type: Optional[str] = None, parameter_server_command: Optional[str] = None, parameter_server_count: Optional[int] = None, worker_container_user: Optional[str] = None, worker_registry_username: Optional[str] = None, worker_registry_password: Optional[str] = None, worker_registry_url: Optional[str] = None, parameter_server_container_user: Optional[str] = None, parameter_server_registry_username: Optional[str] = None, parameter_server_registry_password: Optional[str] = None, parameter_server_registry_url: Optional[str] = None)

Bases: gradient.api_sdk.models.experiment.BaseExperiment

Multi node experiment class. Inherits from BaseExperiment class

Gradient supports both gRPC and MPI protocols for distributed TensorFlow model training. In your CLI command or config.yaml, specify the experiment type as either multinode.

The two types are:

type: "multi-grpc"

or:

type: "multi-mpi"
Parameters

  • experiment_type_id (int) –

    type of experiment Options:

    "single node"
"GRPC multi node"
"MPI multi node"
"Hyperparameter tuning"

  • worker_container (str) – Worker container (dockerfile)

  • worker_machine_type (str) – Worker machine type

  • worker_command (str) – Worker command

  • worker_count (int) – Worker count

  • parameter_server_container (str) – Parameter server container

  • parameter_server_command (str) – Parameter server command

  • parameter_server_count (int) – Parameter server count

  • worker_container_user (str) – Worker container user

  • worker_registry_username (str) – Registry username for accessing private docker registry container if nessesary

  • worker_registry_password (str) – Registry password for accessing private docker registry container if nessesary

  • parameter_server_container_user (str) – Parameter server container user

  • parameter_server_registry_username (str) – Registry username for accessing private docker registry container if nessesary

  • parameter_server_registry_password (str) – Registry password for accessing private docker registry container if nessesary

experiment_type_id_validator(attribute, value)
__init__(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, is_preemptible: Optional[bool] = None, id: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None, experiment_type_id: Optional[int] = None, worker_container: Optional[str] = None, worker_machine_type: Optional[str] = None, worker_command: Optional[str] = None, worker_count: Optional[int] = None, parameter_server_container: Optional[str] = None, parameter_server_machine_type: Optional[str] = None, parameter_server_command: Optional[str] = None, parameter_server_count: Optional[int] = None, worker_container_user: Optional[str] = None, worker_registry_username: Optional[str] = None, worker_registry_password: Optional[str] = None, worker_registry_url: Optional[str] = None, parameter_server_container_user: Optional[str] = None, parameter_server_registry_username: Optional[str] = None, parameter_server_registry_password: Optional[str] = None, parameter_server_registry_url: Optional[str] = None) → None
class gradient.api_sdk.models.experiment.MpiMultiNodeExperiment(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, is_preemptible: Optional[bool] = None, id: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None, experiment_type_id: Optional[int] = None, worker_container: Optional[str] = None, worker_machine_type: Optional[str] = None, worker_command: Optional[str] = None, worker_count: Optional[int] = None, master_container: Optional[str] = None, master_machine_type: Optional[str] = None, master_command: Optional[str] = None, master_count: Optional[str] = None, worker_container_user: Optional[str] = None, worker_registry_username: Optional[str] = None, worker_registry_password: Optional[str] = None, worker_registry_url: Optional[str] = None, master_container_user: Optional[str] = None, master_registry_username: Optional[str] = None, master_registry_password: Optional[str] = None, master_registry_url: Optional[str] = None)

Bases: gradient.api_sdk.models.experiment.BaseExperiment

__init__(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, is_preemptible: Optional[bool] = None, id: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None, experiment_type_id: Optional[int] = None, worker_container: Optional[str] = None, worker_machine_type: Optional[str] = None, worker_command: Optional[str] = None, worker_count: Optional[int] = None, master_container: Optional[str] = None, master_machine_type: Optional[str] = None, master_command: Optional[str] = None, master_count: Optional[str] = None, worker_container_user: Optional[str] = None, worker_registry_username: Optional[str] = None, worker_registry_password: Optional[str] = None, worker_registry_url: Optional[str] = None, master_container_user: Optional[str] = None, master_registry_username: Optional[str] = None, master_registry_password: Optional[str] = None, master_registry_url: Optional[str] = None) → None

gradient.api_sdk.models.experiment_dataset module

class gradient.api_sdk.models.experiment_dataset.VolumeOptions(kind: Optional[str] = None, size: Optional[str] = None)

Bases: object

__init__(kind: Optional[str] = None, size: Optional[str] = None) → None
class gradient.api_sdk.models.experiment_dataset.ExperimentDataset(id: Optional[str] = None, uri: Optional[str] = None, aws_access_key_id: Optional[str] = None, aws_secret_access_key: Optional[str] = None, aws_endpoint: Optional[str] = None, etag: Optional[str] = None, version_id: Optional[str] = None, name: Optional[str] = None, volume_options: gradient.api_sdk.models.experiment_dataset.VolumeOptions = NOTHING)

Bases: object

__init__(id: Optional[str] = None, uri: Optional[str] = None, aws_access_key_id: Optional[str] = None, aws_secret_access_key: Optional[str] = None, aws_endpoint: Optional[str] = None, etag: Optional[str] = None, version_id: Optional[str] = None, name: Optional[str] = None, volume_options: gradient.api_sdk.models.experiment_dataset.VolumeOptions = NOTHING) → None

gradient.api_sdk.models.hyperparameter module

class gradient.api_sdk.models.hyperparameter.Hyperparameter(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, id: Optional[str] = None, state: Optional[int] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None, experiment_type_id: int = 4, tuning_command: Optional[str] = None, worker_container: Optional[str] = None, worker_machine_type: Optional[str] = None, worker_command: Optional[str] = None, worker_count: Optional[int] = None, worker_use_dockerfile: Optional[bool] = None, worker_dockerfile_path: Optional[str] = None, worker_container_user: Optional[str] = None, worker_registry_username: Optional[str] = None, worker_registry_password: Optional[str] = None, hyperparameter_server_machine_type: Optional[str] = None, hyperparameter_server_container: Optional[str] = None, hyperparameter_server_container_user: Optional[str] = None, hyperparameter_server_registry_username: Optional[str] = None, hyperparameter_server_registry_password: Optional[str] = None, is_preemptible: Optional[bool] = None, trigger_event_id: Optional[str] = None, dockerfile_path: Optional[str] = None, use_dockerfile: Optional[bool] = None, tags: list = NOTHING)

Bases: gradient.api_sdk.models.experiment.BaseExperiment

Hyperparameter job class. Inherits from BaseExperiment class

Parameters

  • experiment_type_id (int) – experiment type, for hyperparameter experiment set to 4

  • tuning_command (str) – Tuning command

  • worker_container (str) – Worker container

  • worker_machine_type (str) – Worker machine type

  • worker_command (str) – Worker command

  • worker_count (int) – Worker count

  • worker_use_dockerfile (bool) – Flag: use dockerfile

  • worker_dockerfile_path (str) – path to dockerfile, if not set default is project root directory

  • worker_container_user (str) – Worker container user

  • worker_registry_username (str) – Worker registry username

  • worker_registry_password (str) – Worker registry password

  • hyperparameter_server_machine_type (str) – Hyperparameter server machine type

  • hyperparameter_server_container (str) – Hyperparameter server container

  • hyperparameter_server_container_user (str) – Hyperparameter server container user

  • hyperparameter_server_registry_username (str) – Hyperparameter server registry username

  • hyperparameter_server_registry_password (str) – Hyperparameter server registry password

  • is_preemptible (bool) – Flag: is preemptible

  • trigger_event_id (str) – GradientCI trigger event id

  • dockerfile_path (str) – Path to dockerfile

  • use_dockerfile (bool) – Flag: use dockerfile

experiment_type_id_validator(attribute, value)
__init__(name: Optional[str] = None, ports: Optional[str] = None, workspace_url: Optional[str] = None, workspace_ref: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, datasets: Optional[list] = None, working_directory: Optional[str] = None, artifact_directory: Optional[str] = None, cluster_id: Optional[str] = None, experiment_env: dict = <class 'dict'>, project_id: Optional[str] = None, model_type: Optional[str] = None, model_path: Optional[str] = None, id: Optional[str] = None, state: Optional[int] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_stopped: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None, experiment_type_id: int = 4, tuning_command: Optional[str] = None, worker_container: Optional[str] = None, worker_machine_type: Optional[str] = None, worker_command: Optional[str] = None, worker_count: Optional[int] = None, worker_use_dockerfile: Optional[bool] = None, worker_dockerfile_path: Optional[str] = None, worker_container_user: Optional[str] = None, worker_registry_username: Optional[str] = None, worker_registry_password: Optional[str] = None, hyperparameter_server_machine_type: Optional[str] = None, hyperparameter_server_container: Optional[str] = None, hyperparameter_server_container_user: Optional[str] = None, hyperparameter_server_registry_username: Optional[str] = None, hyperparameter_server_registry_password: Optional[str] = None, is_preemptible: Optional[bool] = None, trigger_event_id: Optional[str] = None, dockerfile_path: Optional[str] = None, use_dockerfile: Optional[bool] = None, tags: list = NOTHING) → None

gradient.api_sdk.models.job module

class gradient.api_sdk.models.job.JobDataset(id: Optional[str] = None, name: Optional[str] = None, output: Optional[bool] = None)

Bases: object

__init__(id: Optional[str] = None, name: Optional[str] = None, output: Optional[bool] = None) → None
class gradient.api_sdk.models.job.Job(id: Optional[str] = None, name: Optional[str] = None, state: Optional[str] = None, working_directory: Optional[str] = None, artifacts_directory: Optional[str] = None, entrypoint: Optional[str] = None, project_id: Optional[str] = None, project: Optional[str] = None, container: Optional[str] = None, container_url: Optional[str] = None, base_container: Optional[str] = None, base_container_url: Optional[str] = None, machine_type: Optional[str] = None, cluster: Optional[str] = None, cluster_id: Optional[str] = None, usage_rate: Optional[str] = None, started_by_user_id: Optional[str] = None, parent_job_id: Optional[str] = None, job_error: Optional[str] = None, dt_created: Optional[str] = None, dt_modified: Optional[str] = None, dt_provisioning_started: Optional[str] = None, dt_provisioning_finished: Optional[str] = None, dt_started: Optional[str] = None, dt_finished: Optional[str] = None, dt_teardown_started: Optional[str] = None, dt_teardown_finished: Optional[str] = None, dt_deleted: Optional[str] = None, exit_code: Optional[str] = None, queue_position: Optional[str] = None, seq_num: Optional[int] = None, storage_region: Optional[str] = None, cluster_machine: Optional[str] = None, fqdn: Optional[str] = None, ports: Optional[str] = None, is_public: Optional[bool] = None, container_user: Optional[str] = None, has_code: Optional[bool] = None, code_uploaded: Optional[bool] = None, code_commit: Optional[str] = None, run_till_cancelled: Optional[bool] = None, push_on_completion: Optional[bool] = None, new_image_name: Optional[str] = None, cpu_hostname: Optional[str] = None, cpu_count: Optional[int] = None, cpu_model: Optional[str] = None, cpu_flags: Optional[str] = None, cpu_mem: Optional[str] = None, gpu_name: Optional[str] = None, gpu_serial: Optional[str] = None, gpu_device: Optional[str] = None, gpu_driver: Optional[str] = None, gpu_count: Optional[int] = None, gpu_mem: Optional[str] = None, tpu_type: Optional[str] = None, tpu_name: Optional[str] = None, tpu_grpc_url: Optional[str] = None, tpu_tf_version: Optional[str] = None, tpu_dataset_dir: Optional[str] = None, tpu_model_dir: Optional[str] = None, target_node_attrs: Optional[dict] = None, job_env: Optional[dict] = None, env_vars: Optional[dict] = None, shared_mem_mbytes: Optional[int] = None, shutdown_timeout: Optional[int] = None, is_preemptible: Optional[bool] = None, metrics_url: Optional[str] = None, custom_metrics: Optional[str] = None, experiment_id: Optional[str] = None, command: Optional[str] = None, workspace_file_name: Optional[str] = None, use_dockerfile: Optional[str] = None, rel_dockerfile_path: Optional[str] = None, registry_username: Optional[str] = None, registry_password: Optional[str] = None, build_only: Optional[bool] = None, registry_target: Optional[str] = None, registry_target_username: Optional[str] = None, registry_target_password: Optional[str] = None, tags: list = NOTHING, datasets: list = NOTHING)

Bases: object

__init__(id: Optional[str] = None, name: Optional[str] = None, state: Optional[str] = None, working_directory: Optional[str] = None, artifacts_directory: Optional[str] = None, entrypoint: Optional[str] = None, project_id: Optional[str] = None, project: Optional[str] = None, container: Optional[str] = None, container_url: Optional[str] = None, base_container: Optional[str] = None, base_container_url: Optional[str] = None, machine_type: Optional[str] = None, cluster: Optional[str] = None, cluster_id: Optional[str] = None, usage_rate: Optional[str] = None, started_by_user_id: Optional[str] = None, parent_job_id: Optional[str] = None, job_error: Optional[str] = None, dt_created: Optional[str] = None, dt_modified: Optional[str] = None, dt_provisioning_started: Optional[str] = None, dt_provisioning_finished: Optional[str] = None, dt_started: Optional[str] = None, dt_finished: Optional[str] = None, dt_teardown_started: Optional[str] = None, dt_teardown_finished: Optional[str] = None, dt_deleted: Optional[str] = None, exit_code: Optional[str] = None, queue_position: Optional[str] = None, seq_num: Optional[int] = None, storage_region: Optional[str] = None, cluster_machine: Optional[str] = None, fqdn: Optional[str] = None, ports: Optional[str] = None, is_public: Optional[bool] = None, container_user: Optional[str] = None, has_code: Optional[bool] = None, code_uploaded: Optional[bool] = None, code_commit: Optional[str] = None, run_till_cancelled: Optional[bool] = None, push_on_completion: Optional[bool] = None, new_image_name: Optional[str] = None, cpu_hostname: Optional[str] = None, cpu_count: Optional[int] = None, cpu_model: Optional[str] = None, cpu_flags: Optional[str] = None, cpu_mem: Optional[str] = None, gpu_name: Optional[str] = None, gpu_serial: Optional[str] = None, gpu_device: Optional[str] = None, gpu_driver: Optional[str] = None, gpu_count: Optional[int] = None, gpu_mem: Optional[str] = None, tpu_type: Optional[str] = None, tpu_name: Optional[str] = None, tpu_grpc_url: Optional[str] = None, tpu_tf_version: Optional[str] = None, tpu_dataset_dir: Optional[str] = None, tpu_model_dir: Optional[str] = None, target_node_attrs: Optional[dict] = None, job_env: Optional[dict] = None, env_vars: Optional[dict] = None, shared_mem_mbytes: Optional[int] = None, shutdown_timeout: Optional[int] = None, is_preemptible: Optional[bool] = None, metrics_url: Optional[str] = None, custom_metrics: Optional[str] = None, experiment_id: Optional[str] = None, command: Optional[str] = None, workspace_file_name: Optional[str] = None, use_dockerfile: Optional[str] = None, rel_dockerfile_path: Optional[str] = None, registry_username: Optional[str] = None, registry_password: Optional[str] = None, build_only: Optional[bool] = None, registry_target: Optional[str] = None, registry_target_username: Optional[str] = None, registry_target_password: Optional[str] = None, tags: list = NOTHING, datasets: list = NOTHING) → None

gradient.api_sdk.models.log module

class gradient.api_sdk.models.log.LogRow(line, message, timestamp)

Bases: tuple

line

Alias for field number 0

message

Alias for field number 1

timestamp

Alias for field number 2

gradient.api_sdk.models.machine module

class gradient.api_sdk.models.machine.Machine(id: Optional[str] = None, name: Optional[str] = None, machine_type: Optional[str] = None, region: Optional[str] = None, size: Optional[int] = None, billing_type: Optional[str] = None, template_id: Optional[str] = None, assign_public_ip: Optional[bool] = None, dynamic_public_ip: Optional[str] = None, network_id: Optional[str] = None, team_id: Optional[str] = None, user_id: Optional[str] = None, email: Optional[str] = None, password: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, notification_email: Optional[str] = None, script_id: Optional[str] = None, os: Optional[str] = None, cpus: Optional[str] = None, ram: Optional[int] = None, gpu: Optional[str] = None, state: Optional[str] = None, updates_pending: Optional[bool] = None, perform_auto_snapshot: Optional[str] = None, auto_snapshot_frequency: Optional[str] = None, auto_snapshot_save_count: Optional[int] = None, shutdown_timeout_in_hours: Optional[str] = None, shutdown_timeout_forces: Optional[bool] = None, agent_type: Optional[str] = None, storage_total: Optional[str] = None, storage_used: Optional[str] = None, public_ip_address: Optional[str] = None, private_ip_address: Optional[int] = None, usage_rate: Optional[int] = None, created_timestamp: Optional[str] = None, last_run_timestamp: Optional[str] = None, events: Optional[list] = None, tags: list = NOTHING)

Bases: object

__init__(id: Optional[str] = None, name: Optional[str] = None, machine_type: Optional[str] = None, region: Optional[str] = None, size: Optional[int] = None, billing_type: Optional[str] = None, template_id: Optional[str] = None, assign_public_ip: Optional[bool] = None, dynamic_public_ip: Optional[str] = None, network_id: Optional[str] = None, team_id: Optional[str] = None, user_id: Optional[str] = None, email: Optional[str] = None, password: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, notification_email: Optional[str] = None, script_id: Optional[str] = None, os: Optional[str] = None, cpus: Optional[str] = None, ram: Optional[int] = None, gpu: Optional[str] = None, state: Optional[str] = None, updates_pending: Optional[bool] = None, perform_auto_snapshot: Optional[str] = None, auto_snapshot_frequency: Optional[str] = None, auto_snapshot_save_count: Optional[int] = None, shutdown_timeout_in_hours: Optional[str] = None, shutdown_timeout_forces: Optional[bool] = None, agent_type: Optional[str] = None, storage_total: Optional[str] = None, storage_used: Optional[str] = None, public_ip_address: Optional[str] = None, private_ip_address: Optional[int] = None, usage_rate: Optional[int] = None, created_timestamp: Optional[str] = None, last_run_timestamp: Optional[str] = None, events: Optional[list] = None, tags: list = NOTHING) → None
class gradient.api_sdk.models.machine.MachineEvent(name: Optional[str] = None, state: Optional[str] = None, created: Optional[str] = None)

Bases: object

__init__(name: Optional[str] = None, state: Optional[str] = None, created: Optional[str] = None) → None
class gradient.api_sdk.models.machine.MachineUtilization(machine_id: Optional[str] = None, machine_seconds_used: Optional[float] = None, machine_billing_month: Optional[str] = None, machine_hourly_rate: Optional[str] = None, storage_seconds_used: Optional[float] = None, storage_billing_month: Optional[str] = None, storage_monthly_rate: Optional[str] = None)

Bases: object

__init__(machine_id: Optional[str] = None, machine_seconds_used: Optional[float] = None, machine_billing_month: Optional[str] = None, machine_hourly_rate: Optional[str] = None, storage_seconds_used: Optional[float] = None, storage_billing_month: Optional[str] = None, storage_monthly_rate: Optional[str] = None) → None

gradient.api_sdk.models.model module

class gradient.api_sdk.models.model.Model(id: Optional[str] = None, name: Optional[str] = None, project_id: Optional[str] = None, experiment_id: Optional[str] = None, cluster_id: Optional[str] = None, tags: list = NOTHING, model_type: Optional[str] = None, url: Optional[str] = None, model_path: Optional[str] = None, deployment_state: Optional[str] = None, summary: Optional[dict] = None, detail: Optional[dict] = None, notes: Optional[str] = None, dataset_ref: Optional[str] = None)

Bases: object

Model class

Parameters

  • id (str) –

  • name (str) –

  • project_id (str) –

  • experiment_id (str) –

  • cluster_id (str) –

  • tags (list) –

  • model_type (str) –

  • url (str) –

  • model_path (str) –

  • deployment_state (str) –

  • summary (str) –

  • detail (str) –

  • dataset_ref (str) –

__init__(id: Optional[str] = None, name: Optional[str] = None, project_id: Optional[str] = None, experiment_id: Optional[str] = None, cluster_id: Optional[str] = None, tags: list = NOTHING, model_type: Optional[str] = None, url: Optional[str] = None, model_path: Optional[str] = None, deployment_state: Optional[str] = None, summary: Optional[dict] = None, detail: Optional[dict] = None, notes: Optional[str] = None, dataset_ref: Optional[str] = None) → None
class gradient.api_sdk.models.model.ModelFile(file: Optional[str] = None, url: Optional[str] = None, size: Optional[int] = None)

Bases: object

Model file

Parameters

  • file (str) – file path

  • url (str) – Url with AWS key

  • size (int) – File size in bytes

__init__(file: Optional[str] = None, url: Optional[str] = None, size: Optional[int] = None) → None

gradient.api_sdk.models.notebook module

class gradient.api_sdk.models.notebook.Notebook(id: Optional[str] = None, machine_type: Optional[str] = None, vm_type_id: Optional[int] = None, vm_type_label: Optional[str] = None, container_id: Optional[int] = None, container_name: Optional[str] = None, name: Optional[str] = None, cluster_id: Optional[str] = None, registry_username: Optional[str] = None, registry_password: Optional[str] = None, command: Optional[str] = None, default_entrypoint: Optional[str] = None, container_user: Optional[str] = None, shutdown_timeout: Optional[int] = None, is_preemptible: Optional[bool] = None, project_id: Optional[str] = None, project_handle: Optional[str] = None, state: Optional[str] = None, vm_type: Optional[str] = None, fqdn: Optional[str] = None, namespace: Optional[str] = None, tags: list = NOTHING, metrics_url: Optional[str] = None, is_public: Optional[str] = None, token: Optional[str] = None, job_error: Optional[str] = None, job_handle: Optional[str] = None, container: Optional[str] = None, container_url: Optional[str] = None, base_container: Optional[str] = None, base_container_url: Optional[str] = None, environment: Optional[dict] = None, workspace: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, workspace_ref: Optional[str] = None, should_run_on_create: Optional[str] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_provisioning_started: Optional[datetime.datetime] = None, dt_provisioning_finished: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_finished: Optional[datetime.datetime] = None, dt_teardown_started: Optional[datetime.datetime] = None, dt_teardown_finished: Optional[datetime.datetime] = None, dt_workspace_upload_finished: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None)

Bases: object

property url
__init__(id: Optional[str] = None, machine_type: Optional[str] = None, vm_type_id: Optional[int] = None, vm_type_label: Optional[str] = None, container_id: Optional[int] = None, container_name: Optional[str] = None, name: Optional[str] = None, cluster_id: Optional[str] = None, registry_username: Optional[str] = None, registry_password: Optional[str] = None, command: Optional[str] = None, default_entrypoint: Optional[str] = None, container_user: Optional[str] = None, shutdown_timeout: Optional[int] = None, is_preemptible: Optional[bool] = None, project_id: Optional[str] = None, project_handle: Optional[str] = None, state: Optional[str] = None, vm_type: Optional[str] = None, fqdn: Optional[str] = None, namespace: Optional[str] = None, tags: list = NOTHING, metrics_url: Optional[str] = None, is_public: Optional[str] = None, token: Optional[str] = None, job_error: Optional[str] = None, job_handle: Optional[str] = None, container: Optional[str] = None, container_url: Optional[str] = None, base_container: Optional[str] = None, base_container_url: Optional[str] = None, environment: Optional[dict] = None, workspace: Optional[str] = None, workspace_username: Optional[str] = None, workspace_password: Optional[str] = None, workspace_ref: Optional[str] = None, should_run_on_create: Optional[str] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None, dt_provisioning_started: Optional[datetime.datetime] = None, dt_provisioning_finished: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_finished: Optional[datetime.datetime] = None, dt_teardown_started: Optional[datetime.datetime] = None, dt_teardown_finished: Optional[datetime.datetime] = None, dt_workspace_upload_finished: Optional[datetime.datetime] = None, dt_deleted: Optional[datetime.datetime] = None) → None
class gradient.api_sdk.models.notebook.NotebookStart(notebook_id: Optional[str] = None, machine_type: Optional[str] = None, vm_type_id: Optional[int] = None, vm_type_label: Optional[str] = None, cluster_id: Optional[str] = None, shutdown_timeout: Optional[int] = None, is_preemptible: Optional[bool] = None)

Bases: object

__init__(notebook_id: Optional[str] = None, machine_type: Optional[str] = None, vm_type_id: Optional[int] = None, vm_type_label: Optional[str] = None, cluster_id: Optional[str] = None, shutdown_timeout: Optional[int] = None, is_preemptible: Optional[bool] = None) → None

gradient.api_sdk.models.pagination module

class gradient.api_sdk.models.pagination.Pagination(data: Optional[list] = None, start_after: Optional[str] = None)

Bases: object

Pagination class

Parameters

  • data (list[Any]) –

  • start_after (str) –

__init__(data: Optional[list] = None, start_after: Optional[str] = None) → None

gradient.api_sdk.models.project module

class gradient.api_sdk.models.project.Project(id: Optional[str] = None, name: Optional[str] = None, repository_name: Optional[str] = None, repository_url: Optional[str] = None, created: Optional[datetime.datetime] = None, tags: list = NOTHING)

Bases: object

Project class

Parameters

  • id (str) –

  • name (str) –

  • repository_name (str) –

  • repository_url (str) –

  • created (datetime) –

__init__(id: Optional[str] = None, name: Optional[str] = None, repository_name: Optional[str] = None, repository_url: Optional[str] = None, created: Optional[datetime.datetime] = None, tags: list = NOTHING) → None

gradient.api_sdk.models.secret module

class gradient.api_sdk.models.secret.Secret(name: Optional[str] = None)

Bases: object

__init__(name: Optional[str] = None) → None

gradient.api_sdk.models.storage_provider module

class gradient.api_sdk.models.storage_provider.StorageProvider(id: Optional[str] = None, type: Optional[str] = None, name: Optional[str] = None, config: dict = NOTHING)

Bases: object

Storage provider class

__init__(id: Optional[str] = None, type: Optional[str] = None, name: Optional[str] = None, config: dict = NOTHING) → None

gradient.api_sdk.models.tag module

class gradient.api_sdk.models.tag.Tag(id: Optional[str] = None, name: Optional[str] = None, created: Optional[datetime.datetime] = None)

Bases: object

__init__(id: Optional[str] = None, name: Optional[str] = None, created: Optional[datetime.datetime] = None) → None

gradient.api_sdk.models.tensorboard module

class gradient.api_sdk.models.tensorboard.Instance(type: Optional[str] = None, size: Optional[str] = None, count: Optional[int] = None)

Bases: object

__init__(type: Optional[str] = None, size: Optional[str] = None, count: Optional[int] = None) → None
class gradient.api_sdk.models.tensorboard.Tensorboard(id: Optional[str] = None, image: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None, instance: Optional[gradient.api_sdk.models.tensorboard.Instance] = None, experiments: Optional[list] = None, url: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING)

Bases: object

__init__(id: Optional[str] = None, image: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None, instance: Optional[gradient.api_sdk.models.tensorboard.Instance] = None, experiments: Optional[list] = None, url: Optional[str] = None, state: Optional[int] = None, tags: list = NOTHING) → None

gradient.api_sdk.models.vm_type module

class gradient.api_sdk.models.vm_type.VmTypeGpuModel(label: Optional[str] = None, model: Optional[str] = None, memory_in_bytes: Optional[int] = None)

Bases: object

__init__(label: Optional[str] = None, model: Optional[str] = None, memory_in_bytes: Optional[int] = None) → None
class gradient.api_sdk.models.vm_type.VmType(label: Optional[str] = None, kind: Optional[str] = None, cpu_count: Optional[int] = None, ram_in_bytes: Optional[int] = None, gpu_count: Optional[int] = None, gpu_model: Optional[gradient.api_sdk.models.vm_type.VmTypeGpuModel] = None, is_preemptible: Optional[bool] = None, deployment_type: Optional[str] = None, deployment_size: Optional[str] = None, clusters: list = NOTHING)

Bases: object

__init__(label: Optional[str] = None, kind: Optional[str] = None, cpu_count: Optional[int] = None, ram_in_bytes: Optional[int] = None, gpu_count: Optional[int] = None, gpu_model: Optional[gradient.api_sdk.models.vm_type.VmTypeGpuModel] = None, is_preemptible: Optional[bool] = None, deployment_type: Optional[str] = None, deployment_size: Optional[str] = None, clusters: list = NOTHING) → None

gradient.api_sdk.models.workflows module

class gradient.api_sdk.models.workflows.Workflow(id: Optional[str] = None, team_id: Optional[int] = None, project_id: Optional[int] = None, name: Optional[str] = None, workflow_spec_id: Optional[str] = None, dt_deleted: Optional[datetime.datetime] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None)

Bases: object

__init__(id: Optional[str] = None, team_id: Optional[int] = None, project_id: Optional[int] = None, name: Optional[str] = None, workflow_spec_id: Optional[str] = None, dt_deleted: Optional[datetime.datetime] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None) → None
class gradient.api_sdk.models.workflows.WorkflowSpec(id: Optional[str] = None, data: Optional[str] = None, hash_sha256: Optional[str] = None, dt_created: Optional[datetime.datetime] = None)

Bases: object

__init__(id: Optional[str] = None, data: Optional[str] = None, hash_sha256: Optional[str] = None, dt_created: Optional[datetime.datetime] = None) → None
class gradient.api_sdk.models.workflows.WorkflowRun(id: Optional[str] = None, team_id: Optional[int] = None, workflow_id: Optional[str] = None, cluster_id: Optional[int] = None, user_id: Optional[int] = None, workflow_spec_id: Optional[str] = None, seq_num: Optional[int] = None, timeout: Optional[int] = None, workflow_phase_id: Optional[int] = None, name: Optional[str] = None, message: Optional[str] = None, dt_status: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_finished: Optional[datetime.datetime] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None)

Bases: object

__init__(id: Optional[str] = None, team_id: Optional[int] = None, workflow_id: Optional[str] = None, cluster_id: Optional[int] = None, user_id: Optional[int] = None, workflow_spec_id: Optional[str] = None, seq_num: Optional[int] = None, timeout: Optional[int] = None, workflow_phase_id: Optional[int] = None, name: Optional[str] = None, message: Optional[str] = None, dt_status: Optional[datetime.datetime] = None, dt_started: Optional[datetime.datetime] = None, dt_finished: Optional[datetime.datetime] = None, dt_created: Optional[datetime.datetime] = None, dt_modified: Optional[datetime.datetime] = None) → None

Module contents