gradient.api_sdk.serializers package

Submodules

gradient.api_sdk.serializers.artifact module

class gradient.api_sdk.serializers.artifact.ArtifactSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.artifact.Artifact

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.base module

class gradient.api_sdk.serializers.base.BaseSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: marshmallow.schema.Schema

MODEL = None

remove_none_or_empty_values(data)

get_instance(obj_dict, many=False)

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.cluster module

class gradient.api_sdk.serializers.cluster.ClusterSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.cluster.Cluster

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.dataset module

class gradient.api_sdk.serializers.dataset.DatasetSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.dataset.Dataset

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.dataset.DatasetRefSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.dataset.DatasetSchema

MODEL

alias of gradient.api_sdk.models.dataset.DatasetRef

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.dataset_tag module

class gradient.api_sdk.serializers.dataset_tag.DatasetVersionSummarySchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.dataset_tag.DatasetVersionSummary

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.dataset_tag.DatasetTagSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.dataset_tag.DatasetTag

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.dataset_version module

class gradient.api_sdk.serializers.dataset_version.DatasetVersionSummarySchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.dataset_version.DatasetVersionTagSummary

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.dataset_version.DatasetVersionSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.dataset_version.DatasetVersion

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.dataset_version.DatasetVersionPreSignedURLSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.dataset_version.DatasetVersionPreSignedURL

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.deployment module

class gradient.api_sdk.serializers.deployment.AutoscalingMetricSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.deployment.AutoscalingMetric

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.deployment.AutoscalingDefinitionSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.deployment.AutoscalingDefinition

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.deployment.DeploymentSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.deployment.Deployment

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.deployment.DeploymentCreateSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.deployment.DeploymentSchema

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.experiment module

class gradient.api_sdk.serializers.experiment.BaseExperimentSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

get_instance(obj_dict, many=False)

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.experiment.SingleNodeExperimentSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.experiment.BaseExperimentSchema

MODEL

alias of gradient.api_sdk.models.experiment.SingleNodeExperiment

preprocess(data, **kwargs)

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.experiment.MultiNodeExperimentSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.experiment.BaseExperimentSchema

MODEL

alias of gradient.api_sdk.models.experiment.MultiNodeExperiment

preprocess(data, **kwargs)

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.experiment.MpiMultiNodeExperimentSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.experiment.BaseExperimentSchema

MODEL

alias of gradient.api_sdk.models.experiment.MpiMultiNodeExperiment

preprocess(data, **kwargs)

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.experiment_dataset module

class gradient.api_sdk.serializers.experiment_dataset.VolumeOptionsSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.experiment_dataset.VolumeOptions

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.experiment_dataset.ExperimentDatasetSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.experiment_dataset.ExperimentDataset

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.hyperparameter module

class gradient.api_sdk.serializers.hyperparameter.HyperparameterSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.experiment.BaseExperimentSchema

MODEL

alias of gradient.api_sdk.models.hyperparameter.Hyperparameter

preprocess(data, **kwargs)

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.job module

class gradient.api_sdk.serializers.job.JSONField(default=<marshmallow.missing>, attribute=None, load_from=None, dump_to=None, error=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, missing=<marshmallow.missing>, error_messages=None, **metadata)

Bases: marshmallow.fields.Field

Field that serializes to json

class gradient.api_sdk.serializers.job.JobDatasetSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.job.JobDataset

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.job.JobSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.job.Job

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.log module

class gradient.api_sdk.serializers.log.LogRowSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.log.LogRow

rstrip_log_line(data)

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.machine module

class gradient.api_sdk.serializers.machine.MachineEventSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.machine.MachineEvent

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.machine.MachineSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.machine.Machine

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.machine.MachineSchemaForListing(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.machine.MachineSchema

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.model module

class gradient.api_sdk.serializers.model.Model(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.model.Model

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.model.ModelFileSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.model.ModelFile

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.notebook module

class gradient.api_sdk.serializers.notebook.NotebookSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.notebook.Notebook

preprocess(data, **kwargs)

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.notebook.NotebookStartSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.notebook.NotebookStart

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.project module

class gradient.api_sdk.serializers.project.Project(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.project.Project

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.secret module

class gradient.api_sdk.serializers.secret.SecretSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.secret.Secret

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.storage_provider module

class gradient.api_sdk.serializers.storage_provider.StorageProviderSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.storage_provider.StorageProvider

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.tag module

class gradient.api_sdk.serializers.tag.TagSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.tag.Tag

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.tensorboard module

class gradient.api_sdk.serializers.tensorboard.InstanceType(value)

Bases: enum.Enum

An enumeration.

CPU = 'cpu'

GPU = 'gpu'

class gradient.api_sdk.serializers.tensorboard.InstanceSize(value)

Bases: enum.Enum

An enumeration.

SMALL = 'small'

MEDIUM = 'medium'

LARGE = 'large'

class gradient.api_sdk.serializers.tensorboard.InstanceSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.tensorboard.Instance

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.tensorboard.TBExperimentSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.tensorboard.TensorboardDetailSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.tensorboard.Tensorboard

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.tensorboard.TensorboardSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.tensorboard.Tensorboard

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.utils module

gradient.api_sdk.serializers.utils.get_serializer_for_experiment(experiment_dict)

Parameters

experiment_dict (dict) –

Return type

serializers.BaseExperimentSchema

gradient.api_sdk.serializers.utils.paginate_schema(schema)

gradient.api_sdk.serializers.vm_type module

class gradient.api_sdk.serializers.vm_type.VmTypeGpuModelSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.vm_type.VmTypeGpuModel

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.vm_type.VmTypeSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.vm_type.VmType

preprocess(data, **kwargs)

opts = <marshmallow.schema.SchemaOpts object>

gradient.api_sdk.serializers.workflows module

class gradient.api_sdk.serializers.workflows.WorkflowSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.workflows.Workflow

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.workflows.WorkflowSpecSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.workflows.WorkflowSpec

opts = <marshmallow.schema.SchemaOpts object>

class gradient.api_sdk.serializers.workflows.WorkflowRunSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: gradient.api_sdk.serializers.base.BaseSchema

MODEL

alias of gradient.api_sdk.models.workflows.WorkflowRun

opts = <marshmallow.schema.SchemaOpts object>

Module contents