gradient.api_sdk.repositories package

Submodules

gradient.api_sdk.repositories.clusters module

class gradient.api_sdk.repositories.clusters.ValidateClusterRepository(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.GetResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.cluster.ClusterSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.clusters.ListClusters(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListResources

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.cluster.ClusterSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

gradient.api_sdk.repositories.common module

class gradient.api_sdk.repositories.common.BaseRepository(api_key, logger, ps_client_name=None)

Bases: object

VALIDATION_ERROR_MESSAGE = 'Failed to fetch data'

__init__(api_key, logger, ps_client_name=None)

abstract get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.common.ListResources(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.BaseRepository

SERIALIZER_CLS = None

list(**kwargs)

class gradient.api_sdk.repositories.common.GetResource(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.BaseRepository

SERIALIZER_CLS = None

get(**kwargs)

class gradient.api_sdk.repositories.common.CreateResource(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.BaseRepository

SERIALIZER_CLS = None

VALIDATION_ERROR_MESSAGE = 'Failed to create resource'

HANDLE_FIELD = 'handle'

create(instance, data=None, path=None)

class gradient.api_sdk.repositories.common.AlterResource(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.BaseRepository

SERIALIZER_CLS = None

update(id, instance)

class gradient.api_sdk.repositories.common.DeleteResource(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.AlterResource

VALIDATION_ERROR_MESSAGE = 'Failed to delete resource'

delete(id_, **kwargs)

class gradient.api_sdk.repositories.common.StartResource(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.AlterResource

VALIDATION_ERROR_MESSAGE = 'Unable to start instance'

start(id_)

class gradient.api_sdk.repositories.common.StopResource(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.AlterResource

VALIDATION_ERROR_MESSAGE = 'Unable to stop instance'

stop(id_)

class gradient.api_sdk.repositories.common.GetMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.GetResource

OBJECT_TYPE = None

DEFAULT_INTERVAL = '30s'

DEFAULT_METRICS = ['cpuPercentage', 'memoryUsage']

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.common.ListMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.GetResource

OBJECT_TYPE = None

DEFAULT_INTERVAL = '30s'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.common.StreamMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.BaseRepository

OBJECT_TYPE = None

DEFAULT_INTERVAL = '30s'

DEFAULT_METRICS = ['cpuPercentage', 'memoryUsage']

stream(**kwargs)

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.common.ListLogs(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

yield_logs(id, line=1, limit=10000)

gradient.api_sdk.repositories.dataset_tags module

class gradient.api_sdk.repositories.dataset_tags.DatasetTagMixin

Bases: gradient.api_sdk.repositories.datasets.DatasetMixin

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.dataset_tag.DatasetTagSchema

classmethod get_request_url(id='', name=None, **kwargs)

class gradient.api_sdk.repositories.dataset_tags.ListDatasetTags(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_tags.DatasetTagMixin, gradient.api_sdk.repositories.common.ListResources

class gradient.api_sdk.repositories.dataset_tags.SetDatasetTag(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_tags.DatasetTagMixin, gradient.api_sdk.repositories.common.AlterResource

HANDLE_FIELD = 'tag'

class gradient.api_sdk.repositories.dataset_tags.GetDatasetTag(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_tags.DatasetTagMixin, gradient.api_sdk.repositories.common.GetResource

class gradient.api_sdk.repositories.dataset_tags.DeleteDatasetTag(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_tags.DatasetTagMixin, gradient.api_sdk.repositories.common.DeleteResource

gradient.api_sdk.repositories.dataset_versions module

class gradient.api_sdk.repositories.dataset_versions.DatasetVersionMixin

Bases: gradient.api_sdk.repositories.datasets.DatasetMixin

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.dataset_version.DatasetVersionSchema

classmethod get_request_url(id='', **kwargs)

class gradient.api_sdk.repositories.dataset_versions.ListDatasetVersions(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_versions.DatasetVersionMixin, gradient.api_sdk.repositories.common.ListResources

class gradient.api_sdk.repositories.dataset_versions.CreateDatasetVersion(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_versions.DatasetVersionMixin, gradient.api_sdk.repositories.common.CreateResource

HANDLE_FIELD = 'version'

class gradient.api_sdk.repositories.dataset_versions.GetDatasetVersion(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_versions.DatasetVersionMixin, gradient.api_sdk.repositories.common.GetResource

class gradient.api_sdk.repositories.dataset_versions.UpdateDatasetVersion(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_versions.DatasetVersionMixin, gradient.api_sdk.repositories.common.AlterResource

class gradient.api_sdk.repositories.dataset_versions.DeleteDatasetVersion(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_versions.DatasetVersionMixin, gradient.api_sdk.repositories.common.DeleteResource

class gradient.api_sdk.repositories.dataset_versions.GenerateDatasetVersionPreSignedS3Urls(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.dataset_versions.DatasetVersionMixin, gradient.api_sdk.repositories.common.BaseRepository

classmethod get_request_url(id=None, **kwargs)

generate(id, calls)

gradient.api_sdk.repositories.datasets module

class gradient.api_sdk.repositories.datasets.DatasetMixin

Bases: object

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.dataset.DatasetSchema

static get_request_url(**kwargs)

class gradient.api_sdk.repositories.datasets.ListDatasets(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.datasets.DatasetMixin, gradient.api_sdk.repositories.common.ListResources

class gradient.api_sdk.repositories.datasets.CreateDataset(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.datasets.DatasetMixin, gradient.api_sdk.repositories.common.CreateResource

HANDLE_FIELD = 'id'

class gradient.api_sdk.repositories.datasets.GetDataset(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.datasets.DatasetMixin, gradient.api_sdk.repositories.common.GetResource

class gradient.api_sdk.repositories.datasets.UpdateDataset(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.datasets.DatasetMixin, gradient.api_sdk.repositories.common.AlterResource

class gradient.api_sdk.repositories.datasets.DeleteDataset(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.datasets.DatasetMixin, gradient.api_sdk.repositories.common.DeleteResource

class gradient.api_sdk.repositories.datasets.GetDatasetRef(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.datasets.DatasetMixin, gradient.api_sdk.repositories.common.GetResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.dataset.DatasetRefSchema

static get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

gradient.api_sdk.repositories.deployments module

class gradient.api_sdk.repositories.deployments.GetBaseDeploymentApiUrlMixin

Bases: object

class gradient.api_sdk.repositories.deployments.ListDeployments(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.deployments.GetBaseDeploymentApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.deployments.CreateDeployment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.deployments.GetBaseDeploymentApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.deployment.DeploymentCreateSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.deployments.StartDeployment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.deployments.GetBaseDeploymentApiUrlMixin, gradient.api_sdk.repositories.common.StartResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.deployments.StopDeployment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.deployments.GetBaseDeploymentApiUrlMixin, gradient.api_sdk.repositories.common.StopResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.deployments.DeleteDeployment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.deployments.GetBaseDeploymentApiUrlMixin, gradient.api_sdk.repositories.common.DeleteResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.deployments.UpdateDeployment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.deployments.GetBaseDeploymentApiUrlMixin, gradient.api_sdk.repositories.common.AlterResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.deployment.DeploymentSchema

VALIDATION_ERROR_MESSAGE = 'Failed to update resource'

update(id, instance)

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.deployments.GetDeployment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.deployments.GetBaseDeploymentApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.deployment.DeploymentSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.deployments.GetDeploymentMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.GetMetrics

OBJECT_TYPE = 'modelDeployment'

class gradient.api_sdk.repositories.deployments.ListDeploymentMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListMetrics

OBJECT_TYPE = 'modelDeployment'

class gradient.api_sdk.repositories.deployments.StreamDeploymentMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.StreamMetrics

OBJECT_TYPE = 'modelDeployment'

class gradient.api_sdk.repositories.deployments.ListDeploymentLogs(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListLogs

gradient.api_sdk.repositories.experiments module

class gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin

Bases: object

class gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlBasedOnClusterIdMixin

Bases: object

class gradient.api_sdk.repositories.experiments.ParseExperimentDictMixin

Bases: object

class gradient.api_sdk.repositories.experiments.ListExperiments(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.ParseExperimentDictMixin, gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.experiments.GetExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.ParseExperimentDictMixin, gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.experiments.ListExperimentLogs(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListLogs

class gradient.api_sdk.repositories.experiments.BaseCreateExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlBasedOnClusterIdMixin, gradient.api_sdk.repositories.common.CreateResource

get_request_url(**_)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.experiments.CreateSingleNodeExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.BaseCreateExperiment

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.experiment.SingleNodeExperimentSchema

class gradient.api_sdk.repositories.experiments.CreateMultiNodeExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.BaseCreateExperiment

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.experiment.MultiNodeExperimentSchema

class gradient.api_sdk.repositories.experiments.CreateMpiMultiNodeExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.BaseCreateExperiment

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.experiment.MpiMultiNodeExperimentSchema

class gradient.api_sdk.repositories.experiments.RunSingleNodeExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.CreateSingleNodeExperiment

get_request_url(**_)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.experiments.RunMultiNodeExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.CreateMultiNodeExperiment

get_request_url(**_)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.experiments.RunMpiMultiNodeExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.CreateMpiMultiNodeExperiment

get_request_url(**_)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.experiments.StartExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin, gradient.api_sdk.repositories.common.StartResource

VALIDATION_ERROR_MESSAGE = 'Failed to start experiment'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.experiments.StopExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin, gradient.api_sdk.repositories.common.StopResource

VALIDATION_ERROR_MESSAGE = 'Failed to stop experiment'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.experiments.DeleteExperiment(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin, gradient.api_sdk.repositories.common.DeleteResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.experiments.GetExperimentMetricsApiUrlMixin

Bases: object

class gradient.api_sdk.repositories.experiments.GetExperimentMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetExperimentMetricsApiUrlMixin, gradient.api_sdk.repositories.common.GetMetrics

OBJECT_TYPE = 'experiment'

class gradient.api_sdk.repositories.experiments.ListExperimentMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetExperimentMetricsApiUrlMixin, gradient.api_sdk.repositories.common.ListMetrics

OBJECT_TYPE = 'experiment'

class gradient.api_sdk.repositories.experiments.StreamExperimentMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetExperimentMetricsApiUrlMixin, gradient.api_sdk.repositories.common.StreamMetrics

OBJECT_TYPE = 'experiment'

gradient.api_sdk.repositories.gradient_deployments module

gradient.api_sdk.repositories.gradient_deployments.create_deployment(name, project_id, spec, cluster_id=None)

gradient.api_sdk.repositories.gradient_deployments.update_deployment(id, name=None, project_id=None, spec=None, cluster_id=None)

gradient.api_sdk.repositories.gradient_deployments.get_deployment(id, first=100)

gradient.api_sdk.repositories.gradient_deployments.list_deployments(first=100)

gradient.api_sdk.repositories.gradient_deployments.delete_deployment(id)

gradient.api_sdk.repositories.hyperparameter module

class gradient.api_sdk.repositories.hyperparameter.CreateHyperparameterJob(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.hyperparameter.HyperparameterSchema

get_request_url(**_)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.hyperparameter.CreateAndStartHyperparameterJob(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.hyperparameter.CreateHyperparameterJob

get_request_url(**_)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.hyperparameter.ListHyperparameterJobs(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin, gradient.api_sdk.repositories.experiments.ParseExperimentDictMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.hyperparameter.GetHyperparameterTuningJob(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin, gradient.api_sdk.repositories.experiments.ParseExperimentDictMixin, gradient.api_sdk.repositories.common.GetResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.hyperparameter.StartHyperparameterTuningJob(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.experiments.GetBaseExperimentApiUrlMixin, gradient.api_sdk.repositories.common.StartResource

VALIDATION_ERROR_MESSAGE = 'Failed to start hyperparameter tuning job'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

gradient.api_sdk.repositories.jobs module

class gradient.api_sdk.repositories.jobs.GetBaseJobApiUrlMixin

Bases: object

class gradient.api_sdk.repositories.jobs.ListJobs(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.jobs.GetBaseJobApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.jobs.ListJobLogs(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListLogs

class gradient.api_sdk.repositories.jobs.CreateJob(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.jobs.GetBaseJobApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.job.JobSchema

HANDLE_FIELD = 'id'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.jobs.DeleteJob(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.jobs.GetBaseJobApiUrlMixin, gradient.api_sdk.repositories.common.DeleteResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.jobs.StopJob(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.jobs.GetBaseJobApiUrlMixin, gradient.api_sdk.repositories.common.StopResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.jobs.GetJob(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.jobs.GetBaseJobApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.jobs.ListJobArtifacts(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.jobs.GetBaseJobApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.jobs.DeleteJobArtifacts(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.jobs.GetBaseJobApiUrlMixin, gradient.api_sdk.repositories.common.DeleteResource

VALIDATION_ERROR_MESSAGE = 'Failed to delete resource'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.jobs.GetJobArtifacts(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.jobs.GetBaseJobApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.jobs.GetJobMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.GetMetrics

OBJECT_TYPE = 'mljob'

class gradient.api_sdk.repositories.jobs.ListJobMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListMetrics

OBJECT_TYPE = 'mljob'

class gradient.api_sdk.repositories.jobs.StreamJobMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.StreamMetrics

OBJECT_TYPE = 'mljob'

gradient.api_sdk.repositories.machine_types module

class gradient.api_sdk.repositories.machine_types.ListMachineTypes(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListResources

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.vm_type.VmTypeSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

gradient.api_sdk.repositories.machines module

class gradient.api_sdk.repositories.machines.MachinesApiUrlMixin

Bases: object

class gradient.api_sdk.repositories.machines.CheckMachineAvailability(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.BaseRepository

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

get(machine_type, region)

class gradient.api_sdk.repositories.machines.CreateMachine(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.machine.MachineSchema

HANDLE_FIELD = 'id'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.machines.DeleteMachine(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.DeleteResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.machines.ListMachines(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.machines.RestartMachine(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.StartResource

VALIDATION_ERROR_MESSAGE = 'Unable to restart instance'

restart(id_, **kwargs)

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.machines.StartMachine(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.StartResource

restart(id_, **kwargs)

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.machines.StopMachine(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.StopResource

restart(id_)

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.machines.GetMachine(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.machine.MachineSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.machines.UpdateMachine(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.AlterResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.machine.MachineSchema

VALIDATION_ERROR_MESSAGE = 'Failed to update resource'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.machines.GetMachineUtilization(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.machines.MachinesApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.machines.WaitForState(api_key, logger, ps_client_name=None)

Bases: object

__init__(api_key, logger, ps_client_name=None)

wait_for_state(machine_id, state, interval=5)

gradient.api_sdk.repositories.models module

class gradient.api_sdk.repositories.models.ParseModelDictMixin

Bases: object

class gradient.api_sdk.repositories.models.GetBaseModelsApiUrlMixin

Bases: object

class gradient.api_sdk.repositories.models.ListModels(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.models.GetBaseModelsApiUrlMixin, gradient.api_sdk.repositories.models.ParseModelDictMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.models.DeleteModel(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.models.GetBaseModelsApiUrlMixin, gradient.api_sdk.repositories.common.DeleteResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.models.GetPresignedUrlForModelFile(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.GetResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.models.UploadModel(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.models.GetBaseModelsApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.model.Model

HANDLE_FIELD = 'id'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

create(instance, data=None, path=None, cluster_id=None)

class gradient.api_sdk.repositories.models.CreateModel(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.models.GetBaseModelsApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.model.Model

HANDLE_FIELD = 'id'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

create(instance, data=None, path=None)

class gradient.api_sdk.repositories.models.GetModel(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.models.GetBaseModelsApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.model.Model

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.models.ListModelFiles(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.models.GetBaseModelsApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.model.ModelFileSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

gradient.api_sdk.repositories.notebooks module

class gradient.api_sdk.repositories.notebooks.GetNotebookApiUrlMixin

Bases: object

class gradient.api_sdk.repositories.notebooks.CreateNotebook(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.notebooks.GetNotebookApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.notebook.NotebookSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.notebooks.StartNotebook(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.notebooks.GetNotebookApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.notebook.NotebookStartSchema

start(instance, data=None, path=None)

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.notebooks.ForkNotebook(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.notebooks.GetNotebookApiUrlMixin, gradient.api_sdk.repositories.common.BaseRepository

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.notebook.NotebookSchema

VALIDATION_ERROR_MESSAGE = 'Failed to fork notebook'

fork(id_, project_id)

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.notebooks.DeleteNotebook(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.notebooks.GetNotebookApiUrlMixin, gradient.api_sdk.repositories.common.DeleteResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.notebooks.GetNotebook(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.notebooks.GetNotebookApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.notebooks.StopNotebook(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.notebooks.GetNotebookApiUrlMixin, gradient.api_sdk.repositories.common.StopResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.notebooks.ListNotebooks(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.notebooks.GetNotebookApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.notebooks.GetNotebookMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.GetMetrics

OBJECT_TYPE = 'notebook'

class gradient.api_sdk.repositories.notebooks.ListNotebookMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListMetrics

OBJECT_TYPE = 'notebook'

class gradient.api_sdk.repositories.notebooks.StreamNotebookMetrics(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.StreamMetrics

OBJECT_TYPE = 'notebook'

class gradient.api_sdk.repositories.notebooks.ListNotebookArtifacts(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.notebooks.GetNotebookApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.notebooks.ListNotebookLogs(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListLogs

gradient.api_sdk.repositories.projects module

class gradient.api_sdk.repositories.projects.GetBaseProjectsApiUrlMixin

Bases: object

class gradient.api_sdk.repositories.projects.CreateProject(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.projects.GetBaseProjectsApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.project.Project

get_request_url(**_)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.projects.ListProjects(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.projects.GetBaseProjectsApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.project.Project

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.projects.DeleteProject(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.projects.GetBaseProjectsApiUrlMixin, gradient.api_sdk.repositories.common.DeleteResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.projects.GetProject(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.projects.GetBaseProjectsApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.project.Project

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

gradient.api_sdk.repositories.secrets module

class gradient.api_sdk.repositories.secrets.SecretsMixin

Bases: object

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.secret.SecretSchema

class gradient.api_sdk.repositories.secrets.ListSecrets(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.secrets.SecretsMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.secrets.SetSecret(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.secrets.SecretsMixin, gradient.api_sdk.repositories.common.BaseRepository

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

set(**kwargs)

class gradient.api_sdk.repositories.secrets.DeleteSecret(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.secrets.SecretsMixin, gradient.api_sdk.repositories.common.BaseRepository

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

delete(**kwargs)

class gradient.api_sdk.repositories.secrets.EphemeralSecret(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.secrets.SecretsMixin, gradient.api_sdk.repositories.common.BaseRepository

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

create(**kwargs)

gradient.api_sdk.repositories.storage_providers module

class gradient.api_sdk.repositories.storage_providers.StorageProviderMixin

Bases: object

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.storage_provider.StorageProviderSchema

static get_request_url(**kwargs)

class gradient.api_sdk.repositories.storage_providers.ListStorageProviders(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.storage_providers.StorageProviderMixin, gradient.api_sdk.repositories.common.ListResources

class gradient.api_sdk.repositories.storage_providers.CreateStorageProvider(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.storage_providers.StorageProviderMixin, gradient.api_sdk.repositories.common.CreateResource

HANDLE_FIELD = 'id'

class gradient.api_sdk.repositories.storage_providers.GetStorageProvider(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.storage_providers.StorageProviderMixin, gradient.api_sdk.repositories.common.GetResource

class gradient.api_sdk.repositories.storage_providers.UpdateStorageProvider(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.storage_providers.StorageProviderMixin, gradient.api_sdk.repositories.common.AlterResource

class gradient.api_sdk.repositories.storage_providers.DeleteStorageProvider(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.storage_providers.StorageProviderMixin, gradient.api_sdk.repositories.common.DeleteResource

gradient.api_sdk.repositories.tags module

class gradient.api_sdk.repositories.tags.UpdateTagRepository(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.AlterResource

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

update(**kwargs)

class gradient.api_sdk.repositories.tags.ListTagRepository(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

gradient.api_sdk.repositories.tensorboards module

class gradient.api_sdk.repositories.tensorboards.GetTensorboardApiUrlMixin

Bases: object

class gradient.api_sdk.repositories.tensorboards.ParseTensorboardMixin

Bases: object

class gradient.api_sdk.repositories.tensorboards.CreateTensorboard(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.tensorboards.GetTensorboardApiUrlMixin, gradient.api_sdk.repositories.common.CreateResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.tensorboard.TensorboardSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.tensorboards.GetTensorboard(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.tensorboards.ParseTensorboardMixin, gradient.api_sdk.repositories.tensorboards.GetTensorboardApiUrlMixin, gradient.api_sdk.repositories.common.GetResource

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.tensorboard.TensorboardDetailSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.tensorboards.ListTensorboards(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.tensorboards.ParseTensorboardMixin, gradient.api_sdk.repositories.tensorboards.GetTensorboardApiUrlMixin, gradient.api_sdk.repositories.common.ListResources

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.tensorboard.TensorboardDetailSchema

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.tensorboards.UpdateTensorboard(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.tensorboards.ParseTensorboardMixin, gradient.api_sdk.repositories.tensorboards.GetTensorboardApiUrlMixin, gradient.api_sdk.repositories.common.AlterResource

VALIDATION_ERROR_MESSAGE = 'Failed to update resource'

update(id, **kwargs)

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.tensorboards.DeleteTensorboard(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.tensorboards.GetTensorboardApiUrlMixin, gradient.api_sdk.repositories.common.DeleteResource

VALIDATION_ERROR_MESSAGE = 'Failed to delete resource'

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

gradient.api_sdk.repositories.workflows module

class gradient.api_sdk.repositories.workflows.WorkflowsMixin

Bases: object

SERIALIZER_CLS

alias of gradient.api_sdk.serializers.workflows.WorkflowSchema

class gradient.api_sdk.repositories.workflows.ListWorkflows(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.workflows.WorkflowsMixin, gradient.api_sdk.repositories.common.ListResources

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

class gradient.api_sdk.repositories.workflows.GetWorkflow(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.workflows.WorkflowsMixin, gradient.api_sdk.repositories.common.BaseRepository

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

get(**kwargs)

class gradient.api_sdk.repositories.workflows.WorkflowRunsMixin

Bases: object

class gradient.api_sdk.repositories.workflows.ListWorkflowRuns(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.workflows.WorkflowRunsMixin, gradient.api_sdk.repositories.common.BaseRepository

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

get(**kwargs)

class gradient.api_sdk.repositories.workflows.GetWorkflowRun(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.workflows.WorkflowRunsMixin, gradient.api_sdk.repositories.common.BaseRepository

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

get(**kwargs)

class gradient.api_sdk.repositories.workflows.CreateWorkflow(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.workflows.WorkflowsMixin, gradient.api_sdk.repositories.common.BaseRepository

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

create(**kwargs)

class gradient.api_sdk.repositories.workflows.CreateWorkflowRun(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.workflows.WorkflowsMixin, gradient.api_sdk.repositories.common.BaseRepository

get_request_url(**kwargs)

Get url to the endpoint (without base api url)

Return type

str

create(**kwargs)

class gradient.api_sdk.repositories.workflows.ListWorkflowLogs(api_key, logger, ps_client_name=None)

Bases: gradient.api_sdk.repositories.common.ListLogs

Module contents