From 0d060c4fe522cc7edb9ba6612e71217cad611efc Mon Sep 17 00:00:00 2001 From: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com> Date: Fri, 22 Sep 2023 16:53:26 +0200 Subject: [PATCH] chore: update documentation (#390) Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com> --- bin/generate_sdk_schemas_documentation.py | 1 - references/sdk_models.md | 10 +--------- references/sdk_schemas.md | 4 ++-- 3 files changed, 3 insertions(+), 12 deletions(-) diff --git a/bin/generate_sdk_schemas_documentation.py b/bin/generate_sdk_schemas_documentation.py index fc51be32..e76856e5 100644 --- a/bin/generate_sdk_schemas_documentation.py +++ b/bin/generate_sdk_schemas_documentation.py @@ -40,7 +40,6 @@ models.Permissions, models.InModel, models.OutModel, - models._File, ] diff --git a/references/sdk_models.md b/references/sdk_models.md index 15a93c83..915dacce 100644 --- a/references/sdk_models.md +++ b/references/sdk_models.md @@ -10,7 +10,6 @@ - [Permissions](#Permissions) - [InModel](#InModel) - [OutModel](#OutModel) -- [_File](#_File) # Models @@ -48,7 +47,7 @@ Asset creation specification base class. - function: - owner: - compute_plan_key: -- metadata: typing.Union[typing.Dict[str, str], typing.Dict[str, int]] +- metadata: typing.Dict[str, str] - status: - worker: - rank: typing.Optional[int] @@ -150,10 +149,3 @@ Out model of a task - creation_date: ``` -## _File -File as stored in the models -```text -- checksum: -- storage_address: typing.Union[typing.Annotated[pathlib.Path, PathType(path_type='file')], pydantic_core._pydantic_core.Url, str] -``` - diff --git a/references/sdk_schemas.md b/references/sdk_schemas.md index 016b1c7b..fdf57509 100644 --- a/references/sdk_schemas.md +++ b/references/sdk_schemas.md @@ -86,7 +86,7 @@ Asset creation specification base class. - key: - tag: typing.Optional[str] - compute_plan_key: typing.Optional[str] -- metadata: typing.Union[typing.Dict[str, str], typing.Dict[str, int], NoneType] +- metadata: typing.Optional[typing.Dict[str, str]] - function_key: - worker: - rank: typing.Optional[int] @@ -141,7 +141,7 @@ note : metadata field does not accept strings containing '__' as dict key - function_key: - worker: - tag: typing.Optional[str] -- metadata: typing.Union[typing.Dict[str, str], typing.Dict[str, int], NoneType] +- metadata: typing.Optional[typing.Dict[str, str]] - inputs: typing.Optional[typing.List[substra.sdk.schemas.InputRef]] - outputs: typing.Optional[typing.Dict[str, substra.sdk.schemas.ComputeTaskOutputSpec]] ```