sparsify.schemas package

Submodules

sparsify.schemas.errors module

Schemas for anything related to errors occurring in the flask app

class sparsify.schemas.errors.ErrorSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Error schema to return in the event of an error encountered while running the app

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

sparsify.schemas.helpers module

Helper values and classes for marshmallow schemas

class sparsify.schemas.helpers.EnumField(enum_class: Any, *args, **kwargs)

Bases: marshmallow.fields.String

Custom schema field for handling serializing and deserializing enums

Parameters

• enum_class – the enum class to use for deserializing

• args – args to pass to the field

• kwargs – the kwargs to pass to the field

deserialize(value: Any, attr: Optional[str] = None, data: Optional[Mapping[str, Any]] = None, **kwargs)

Deserialize value.

Parameters

• value – The value to deserialize.

• attr – The attribute/key in data to deserialize.

• data – The raw input data passed to Schema.load.

• kwargs – Field-specific keyword arguments.

Raises

ValidationError – If an invalid value is passed or if a required value is missing.

sparsify.schemas.helpers.data_dump_and_validation(schema: marshmallow.schema.Schema, data: Any) → Dict

Use a marshmallow schema to dump and validate input data

Parameters

• schema – the schema to use to dump an object and validate it

• data – the data to dump and validate

Returns

the resulting dumped data from marshmallow

sparsify.schemas.jobs module

Schemas for anything related to job routes, database models, and workers

class sparsify.schemas.jobs.JobProgressSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for the progress of a Job object, used in the workers to report progress

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.jobs.JobSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a job object as stored in the DB and returned in the server routes

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.jobs.ResponseJobSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with a single job

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.jobs.ResponseJobsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with multiple jobs

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.jobs.SearchJobsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for querying jobs

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

sparsify.schemas.model_repo module

Schemas for anything related to model repo routes, database models, and

class sparsify.schemas.model_repo.ModelRepoArchitectureSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a model repo architecture

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.model_repo.ModelRepoDatasetSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a model repo dataset

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.model_repo.ModelRepoDomainSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a model repo domain

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.model_repo.ModelRepoModelDescSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a model repo desc

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.model_repo.ModelRepoModelMetricSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for reporting a metric for a model repo model

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.model_repo.ModelRepoModelPerfSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for reporting the performance for a model repo model

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.model_repo.ModelRepoModelSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a model repo model

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.model_repo.ResponseModelRepoModels(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for the response for searching for models in the model repo

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.model_repo.SearchModelRepoModels(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for searching and filtering models in the model repo

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

sparsify.schemas.projects module

Schemas for anything related to project routes, database models, and workers

class sparsify.schemas.projects.CreateUpdateProjectSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for creating or updating a project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects.DeleteProjectSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for deleting a project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects.ProjectExtSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: sparsify.schemas.projects.ProjectSchema

Schema for a project object including model and data as stored in the DB and returned in the server routes

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects.ProjectSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a project object as stored in the DB and returned in the server routes

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects.ResponseProjectDeletedSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response after deleting a project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects.ResponseProjectExtSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with a single project and its associated model and data

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects.ResponseProjectSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with a single project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects.ResponseProjectsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with multiple project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects.SearchProjectsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for querying projects

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

sparsify.schemas.projects_benchmarks module

Schemas for anything related to project benchmark routes, database models, and workers

class sparsify.schemas.projects_benchmarks.CreateProjectBenchmarkSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for creating a project benchmark

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_benchmarks.ProjectBenchmarkResultSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a project benchmark object’s metadata as stored in the DB

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_benchmarks.ProjectBenchmarkResultsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a project benchmark object’s measured results as stored in the DB

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_benchmarks.ProjectBenchmarkSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a project benchmark object (metadata and result) as stored in the DB and returned in the server routes

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_benchmarks.ResponseProjectBenchmarkDeletedSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for deleting a project benchmark

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_benchmarks.ResponseProjectBenchmarkSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response containing a benchmark project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_benchmarks.ResponseProjectBenchmarksSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response containing multiple benchmark projects

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_benchmarks.SearchProjectBenchmarksSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema to use for querying project benchmarks

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

sparsify.schemas.projects_data module

Schemas for anything related to project data routes, database models, and workers

class sparsify.schemas.projects_data.CreateUpdateProjectDataSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for creating a data file for a project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_data.ProjectDataSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a project data object as stored in the DB and returned in the server routes

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_data.ResponseProjectDataDeletedSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response after deleting a project’s data object and file

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_data.ResponseProjectDataSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with all of the project’s data objects

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_data.ResponseProjectDataSingleSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with a project’s data object

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_data.SearchProjectDataSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema to use for querying project data

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_data.SetProjectDataFromSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for setting a project’s data for upload from path or upload from url

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

sparsify.schemas.projects_model module

Schemas for anything related to project model routes and database

class sparsify.schemas.projects_model.CreateUpdateProjectModelSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for creating a model for a project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_model.DeleteProjectModelSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for deleting a project’s model

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_model.ProjectModelAnalysisSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for the analysis of a project’s model and all the nodes contained

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_model.ProjectModelSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a project model object as stored in the DB an returned in server routes

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_model.ResponseProjectModelAnalysisSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with a project model’s analysis

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_model.ResponseProjectModelDeletedSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response on deletion of a project’s model

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_model.ResponseProjectModelSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with a single project model

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_model.SetProjectModelFromSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for setting a project’s model from some loadable uri

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

sparsify.schemas.projects_optimizations module

Schemas for anything related to project optims routes, database models, and workers

class sparsify.schemas.projects_optimizations.CreateProjectOptimizationSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: sparsify.schemas.projects_optimizations.GetProjectOptimizationBestEstimatedResultsSchema

Schema to use for creating a project optimization

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.CreateUpdateProjectOptimizationModifiersLRScheduleSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema to use for creating or updating a project optimization lr schedule modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.CreateUpdateProjectOptimizationModifiersPruningSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema to use for creating or updating a project optimization pruning modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.CreateUpdateProjectOptimizationModifiersQuantizationSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema to use for creating or updating a project optimization quantization modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.CreateUpdateProjectOptimizationModifiersTrainableSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema to use for creating or updating a project optimization trainable modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.GetProjectOptimizationBestEstimatedResultsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema to use for getting a projects best estimated optimization results

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectAvailableModelModificationsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for the available modifiers for a project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierLRExponentialArgsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for the args for an exponential LR modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierLRMultiStepArgsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for the args for a multi step LR modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierLRScheduleSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for an LR schedule modifier including metadata and settings

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierLRSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for an LR modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierLRSetArgsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for the args for a set LR modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierLRStepArgsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for the args for a step LR modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierPruningNodeSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: sparsify.schemas.projects_optimizations.ProjectOptimizationModifierPruningNodeMetadataSchema, sparsify.schemas.projects_optimizations.ProjectOptimizationModifierEstimationsSchema

Schema for a pruning node containing metadata and estimated values

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierPruningSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: sparsify.schemas.projects_optimizations.ProjectOptimizationModifierEstimationsSchema

Schema for a pruning modifier including metadata, settings, and estimated values

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierQuantizationNodeSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a quantization node containing metadata

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierQuantizationSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a quantization modifier including metadata, settings, and estimated values

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierTrainableNodeSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a trainable node containing metadata

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationModifierTrainableSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a trainable modifier containing metadata and settings

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ProjectOptimizationSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a project optimization containing metadata and modifiers

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ResponseProjectOptimizationDeletedSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning the results of deleting a project optimization

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ResponseProjectOptimizationFrameworksAvailableSamplesSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning the available code samples for a framework for project optimization

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ResponseProjectOptimizationFrameworksAvailableSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning the available frameworks for project optimization

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ResponseProjectOptimizationModifierDeletedSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning the results of deleting a project optimization modifier

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ResponseProjectOptimizationModifiersAvailable(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning the available modifiers for project optimization

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ResponseProjectOptimizationModifiersBestEstimated(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: sparsify.schemas.projects_optimizations.ProjectOptimizationModifierEstimationsSchema

Schema for returning the best estimated results for project optimization

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ResponseProjectOptimizationSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a project optimization

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.ResponseProjectOptimizationsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning multiple project optimizations

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.SearchProjectOptimizationsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema to use for querying project optimizations

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_optimizations.UpdateProjectOptimizationSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema to use for updating a project optimization

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

sparsify.schemas.projects_profiles module

Schemas for anything related to project profile routes, database models, and workers

class sparsify.schemas.projects_profiles.CreateProjectLossProfileSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for creating a loss profile for a project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.CreateProjectPerfProfileSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for creating a performance profile for a project

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectLossProfileSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: sparsify.schemas.projects_profiles.ProjectProfileSchema

Schema for a projects loss profile object as stored in the DB and returned in the server routes

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectPerfProfileSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: sparsify.schemas.projects_profiles.ProjectProfileSchema

Schema for a projects performance profile object as stored in the DB and returned in the server routes

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectProfileAnalysisSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for an analysis for a profiles model and all ops in it. Includes baseline measurements, pruning measurements, and quantization measurements

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectProfileMeasurementSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a profile measurement

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectProfileMeasurementsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for profile measurements including baseline

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectProfileModelOpsBaselineMeasurementsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for baseline measurements for a profiles model and all ops in it

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectProfileModelOpsMeasurementsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for measurements for a profiles model and all ops in it

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectProfileOpBaselineMeasurementSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: sparsify.schemas.projects_profiles.ProjectProfileMeasurementSchema, sparsify.schemas.projects_profiles.ProjectProfileOpSchema

Schema for baseline measurements for a profiles op or node in a model

dump_fields: typing.Dict[str, ma_fields.Field]

fields: typing.Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: typing.Dict[str, ma_fields.Field]

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectProfileOpMeasurementsSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: sparsify.schemas.projects_profiles.ProjectProfileMeasurementsSchema, sparsify.schemas.projects_profiles.ProjectProfileOpSchema

Schema for measurements for a profile op or node in a model

dump_fields: typing.Dict[str, ma_fields.Field]

fields: typing.Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: typing.Dict[str, ma_fields.Field]

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectProfileOpSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for a profile op or node in a model

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ProjectProfileSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Base schema for a projects profile such as loss or perf

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ResponseProjectLossProfileSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with a single loss profile

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ResponseProjectLossProfilesSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with multiple loss profiles

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ResponseProjectPerfProfileSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with a single performance profile

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ResponseProjectPerfProfilesSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with a multiple performance profiles

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.ResponseProjectProfileDeletedSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response after deleting a profile

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.projects_profiles.SearchProjectProfilesSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Expected schema to use for querying project profiles

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

sparsify.schemas.system module

Schemas for anything related to system routes

class sparsify.schemas.system.ResponseSystemInfo(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for returning a response with the system info

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.system.SystemInfo(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Schema for the system info the server is currently running on

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class sparsify.schemas.system.VersionInfoSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

Module contents

Schemas for working with the sparsify server