directory_artifact

DirectoryArtifact.

`DirectoryArtifact` #

Represent raw data uploaded to xpdeep cloud or on premise instance under a directory.

`getitem(item: str) -> str` #

Return file's path in the xpdeep server.

Source code in src/xpdeep/dataset/directory_artifact.py

def __getitem__(self, item: str) -> str:
    """Return file's path in the xpdeep server."""
    return self.files.additional_properties[item]

`len() -> int` #

Give the number of files in the directory.

Source code in src/xpdeep/dataset/directory_artifact.py

def __len__(self) -> int:
    """Give the number of files in the directory."""
    return len(self.files.additional_properties)

`create_directory_artifact(name: str, file_paths: dict[str, str]) -> DirectoryArtifact` #

Create a directory artifact.

Source code in src/xpdeep/dataset/directory_artifact.py

@classmethod
@initialized_client_verification
@initialized_project_verification
def create_directory_artifact(cls, name: str, file_paths: dict[str, str]) -> "DirectoryArtifact":
    """Create a directory artifact."""
    body = DirectoryCreateRequestBody(
        directory_artifact_name=name, dataset_paths=DirectoryCreateRequestBodyDatasetpaths.from_dict(file_paths)
    )

    return DirectoryArtifact.from_dict(
        cast(
            DirectoryModel,
            create_directory.sync(Project.CURRENT.get().model.id, client=ClientFactory.CURRENT.get()(), body=body),
        ).to_dict()
    )

`delete() -> None` #

Delete DirectoryArtifact and related artifact.

Source code in src/xpdeep/dataset/directory_artifact.py

@initialized_client_verification
@initialized_project_verification
def delete(self) -> None:
    """Delete DirectoryArtifact and related artifact."""
    delete_directories.sync(
        Project.CURRENT.get().model.id, client=ClientFactory.CURRENT.get()(), body=IdsRequestBody([self.id])
    )

`list_directories() -> list[Self]` #

Get trained models from a project.

Source code in src/xpdeep/dataset/directory_artifact.py

@classmethod
@initialized_client_verification
@initialized_project_verification
def list_directories(cls) -> list[Self]:
    """Get trained models from a project."""
    return [
        cls.from_dict(directory_model.to_dict())
        for directory_model in cast(
            list[DirectoryModel],
            get_many_directories.sync(Project.CURRENT.get().model.id, client=ClientFactory.CURRENT.get()()),
        )
    ]

directory_artifact