Inheritance diagram for coretex.coretex.experiment.artifact.Artifact:

Public Member Functions
Path	localFilePath (self)

bool	isDirectory (self)

bool	isFile (self)

bool	download (self)

List[Artifact]	fetchAll (cls, int experimentId, Optional[str] path=None, bool recursive=False)

Public Member Functions inherited from coretex.codable.codable.Codable
Dict[str, Any]	encode (self)

None	onDecode (self)

Self	decode (cls, Dict[str, Any] encodedObject)

Detailed Description

    Artifact class represents a single result of an experiment\n
    Result can be file of any kind

    Properties
    ----------
    artifactType : ArtifactType
        type of Artifact
    remoteFilePath : str
        path of Artifact on Coretex
    size : Optional[int]
        size of Artifact in bytes (not required)
    mimeType : str
        mimeType of Artifact
    timestamp : int
        current timestamp
    experimentId : int
        id of experiment

Definition at line 61 of file artifact.py.

Member Function Documentation

◆ download()

bool coretex.coretex.experiment.artifact.Artifact.download ( self )

    Downloads Artifact from Coretex.ai

    Returns
    -------
    bool -> False if response has failed, True otherwise

Definition at line 160 of file artifact.py.

     def download(self) -> bool:
         """
             Downloads Artifact from Coretex.ai
  
             Returns
             -------
             bool -> False if response has failed, True otherwise
         """
  
         artifactsFolder = FolderManager.instance().getArtifactsFolder(self.experimentId)
         if not artifactsFolder.exists():
             artifactsFolder.mkdir(parents = True, exist_ok = True)
  
         return not networkManager.genericDownload(
             f"artifact/download-file?path={self.remoteFilePath}&model_queue_id={self.experimentId}",
             str(self.localFilePath)
         ).hasFailed()
  

◆ fetchAll()

List[Artifact] coretex.coretex.experiment.artifact.Artifact.fetchAll	(		cls,
		int	experimentId,
		Optional[str]	path = `None`,
		bool	recursive = `False`
	)

    Fetch all Artifacts from Coretex.ai for the specified experiment

    Parameters
    ----------
    experimentId : int
id of experiment
    path : Optional[str]
local path where u want to store fetched Artifacts
    recursive : bool
True if you want list to be sorted recursively, False otherwise

Definition at line 179 of file artifact.py.

     def fetchAll(cls, experimentId: int, path: Optional[str] = None, recursive: bool = False) -> List[Artifact]:
         """
             Fetch all Artifacts from Coretex.ai for the specified experiment
  
             Parameters
             ----------
             experimentId : int
                 id of experiment
             path : Optional[str]
                 local path where u want to store fetched Artifacts
             recursive : bool
                 True if you want list to be sorted recursively, False otherwise
         """
  
         queryParameters = [
             f"model_queue_id={experimentId}"
         ]
  
         if path is not None:
             queryParameters.append(f"path={path}")
  
         parameters = "&".join(queryParameters)
         response = networkManager.genericJSONRequest(
             f"artifact/list-contents?{parameters}",
             RequestType.get
         )
  
         if response.hasFailed():
             return []
  
         artifacts = [Artifact.decode(element) for element in response.json]
  
         for artifact in artifacts:
             artifact.experimentId = experimentId
  
             if recursive and artifact.isDirectory:
                 artifacts.extend(
                     cls.fetchAll(experimentId, artifact.remoteFilePath)
                 )
  
         return artifacts

◆ isDirectory()

bool coretex.coretex.experiment.artifact.Artifact.isDirectory ( self )

    Returns
    -------
    bool -> True if Artifact type is directory

Definition at line 103 of file artifact.py.

     def isDirectory(self) -> bool:
         """
             Returns
             -------
             bool -> True if Artifact type is directory
         """
  
         return self.artifactType == ArtifactType.directory
  

◆ isFile()

bool coretex.coretex.experiment.artifact.Artifact.isFile ( self )

    Returns
    -------
    bool -> True if Artifact type is file

Definition at line 113 of file artifact.py.

     def isFile(self) -> bool:
         """
             Returns
             -------
             bool -> True if Artifact type is file
         """
  
         return self.artifactType == ArtifactType.file
  

◆ localFilePath()

Path coretex.coretex.experiment.artifact.Artifact.localFilePath ( self )

    Represents the local path of the Artifact

    Returns
    -------
    Path -> local path to Artifact

Definition at line 91 of file artifact.py.

     def localFilePath(self) -> Path:
         """
             Represents the local path of the Artifact
  
             Returns
             -------
             Path -> local path to Artifact
         """
  
         return FolderManager.instance().getArtifactsFolder(self.experimentId) / self.remoteFilePath
  

The documentation for this class was generated from the following file:

src/coretex/coretex/experiment/artifact.py