Manifest
| CLASS | DESCRIPTION |
|---|---|
ManifestV2 |
Packages containing tasks are required to include a special file |
TaskManifestV2 |
Represents a task within a V2 manifest. |
Attributes¶
Classes¶
ManifestV2
pydantic-model
¶
Bases: BaseModel
Packages containing tasks are required to include a special file
__FRACTAL_MANIFEST__.json in order to be discovered and used by Fractal.
This model class and the model classes it depends on provide the base schema to read, write and validate manifests.
| ATTRIBUTE | DESCRIPTION |
|---|---|
manifest_version |
A version string that provides indication for compatibility between manifests as the schema evolves. This is for instance used by Fractal to determine which subclass of the present base class needs be used to read and validate the input.
TYPE:
|
task_list |
The list of tasks, represented as specified by subclasses of the
TYPE:
|
has_args_schemas |
TYPE:
|
args_schema_version |
Label of how
TYPE:
|
Fields:
-
manifest_version(Literal['2']) -
task_list(list[TaskManifestV2]) -
has_args_schemas(bool) -
args_schema_version(str | None) -
authors(NonEmptyStr | None)
Validators:
-
_check_args_schemas_are_present -
_unique_task_names
Source code in fractal_server/app/schemas/v2/manifest.py
TaskManifestV2
pydantic-model
¶
Bases: BaseModel
Represents a task within a V2 manifest.
| ATTRIBUTE | DESCRIPTION |
|---|---|
name |
The task name
TYPE:
|
executable |
Path to the executable relative to the package root Note: by package root we mean "as it will be installed". If a
package
TYPE:
|
input_type |
The input type accepted by the task
TYPE:
|
output_type |
The output type returned by the task
TYPE:
|
meta |
Additional information about the package, such as hash of the executable, specific runtime requirements (e.g., need_gpu=True), etc.
TYPE:
|
args_schema |
JSON Schema for task arguments
TYPE:
|
docs_info |
Additional information about the Task, coming from the docstring.
TYPE:
|
docs_link |
Link to Task docs.
TYPE:
|
Fields:
-
name(str) -
executable_non_parallel(str | None) -
executable_parallel(str | None) -
input_types(dict[str, bool]) -
output_types(dict[str, bool]) -
meta_non_parallel(DictStrAny) -
meta_parallel(DictStrAny) -
args_schema_non_parallel(DictStrAny | None) -
args_schema_parallel(DictStrAny | None) -
docs_info(str | None) -
docs_link(HttpUrlStr | None) -
category(str | None) -
modality(str | None) -
tags(list[str]) -
type(None | TaskType)
Validators:
-
validate_executable_args_meta