Coretex
Public Member Functions | List of all members
coretex.folder_management.folder_manager.FolderManager Class Reference

Public Member Functions

str createTempFolder (self, str name)
 
str getTempFolder (self, str name)
 
Path getArtifactsFolder (self, int experimentId)
 
None clearTempFiles (self)
 

Detailed Description

    Used for handling everything related to local storage
    when working with Coretex

    Contains
    --------
    samplesFolder : str
        folder where samples are stored
    modelsFolder : str
        folder where models are stored
    temp : str
        folder where temp files and folders are stored,
        this is deleted when the experiment has finished executing

    datasetsFolder : Path
        folder where datasets are stored (samples are symlinked for datasets)
    cache : Path
        folder where cache module stores items
    logs : Path
        folder where node and experiment logs are stored
    environments : Path
        folder where node stores python environments

Definition at line 28 of file folder_manager.py.

Member Function Documentation

◆ clearTempFiles()

None coretex.folder_management.folder_manager.FolderManager.clearTempFiles (   self) 
    Deletes all temp files and folders (including artifacts)

Definition at line 169 of file folder_manager.py.

169  def clearTempFiles(self) -> None:
170  """
171  Deletes all temp files and folders (including artifacts)
172  """
173 
174  self.__clearDirectory(self.temp)
175  self.__clearDirectory(self.__artifactsFolder)
176 

◆ createTempFolder()

str coretex.folder_management.folder_manager.FolderManager.createTempFolder (   self,
str  name 
) 
    Creates temp folder which is deleted once
    the experiment has finished executing

    Parameters
    ----------
    name : str
name of the folder

    Returns
    -------
    str -> path to the created folder

    Raises
    ------
    FileExistsError -> if the temp folder already exists

    Example
    -------
    >>> from coretex.folder_management import FolderManager
    \b
    >>> dummyFolderPath = FolderManager.instance().createTempFolder("dummyTempFolder")
    >>> print(dummyFolderPath)
    "/Users/X/.coretex/temp/dummyTempFolder"

Definition at line 83 of file folder_manager.py.

83  def createTempFolder(self, name: str) -> str:
84  """
85  Creates temp folder which is deleted once
86  the experiment has finished executing
87 
88  Parameters
89  ----------
90  name : str
91  name of the folder
92 
93  Returns
94  -------
95  str -> path to the created folder
96 
97  Raises
98  ------
99  FileExistsError -> if the temp folder already exists
100 
101  Example
102  -------
103  >>> from coretex.folder_management import FolderManager
104  \b
105  >>> dummyFolderPath = FolderManager.instance().createTempFolder("dummyTempFolder")
106  >>> print(dummyFolderPath)
107  "/Users/X/.coretex/temp/dummyTempFolder"
108  """
109 
110  tempFolderPath = os.path.join(self.temp, name)
111 
112  if os.path.exists(tempFolderPath):
113  raise FileExistsError
114 
115  os.mkdir(tempFolderPath)
116  return tempFolderPath
117 

◆ getArtifactsFolder()

Path coretex.folder_management.folder_manager.FolderManager.getArtifactsFolder (   self,
int  experimentId 
) 
    Retrieves the path to where the artifacts are stored
    for the specified experiment

    Parameters
    ----------
    experimentId : int
id of the experiment

    Returns
    -------
    Path -> path to the experiment artifacts local storage

    Example
    -------
    >>> from coretex.folder_management import FolderManager
    \b
    >>> artifactsFolderPath = FolderManager.instance().getArtifactsFolder(1023)
    >>> print(artifactsFolderPath)
    Path("/Users/bogdanbm/.coretex/artifacts/1023")

Definition at line 143 of file folder_manager.py.

143  def getArtifactsFolder(self, experimentId: int) -> Path:
144  """
145  Retrieves the path to where the artifacts are stored
146  for the specified experiment
147 
148  Parameters
149  ----------
150  experimentId : int
151  id of the experiment
152 
153  Returns
154  -------
155  Path -> path to the experiment artifacts local storage
156 
157  Example
158  -------
159  >>> from coretex.folder_management import FolderManager
160  \b
161  >>> artifactsFolderPath = FolderManager.instance().getArtifactsFolder(1023)
162  >>> print(artifactsFolderPath)
163  Path("/Users/bogdanbm/.coretex/artifacts/1023")
164 
165  """
166 
167  return self.__artifactsFolder / str(experimentId)
168 

◆ getTempFolder()

str coretex.folder_management.folder_manager.FolderManager.getTempFolder (   self,
str  name 
) 
    Retrieves the path of the temp folder, does
    not check if the folder exists or not

    Parameters
    ----------
    name : str
name of the folder

    Returns
    -------
    str -> path to the folder

    Example
    -------
    >>> from coretex.folder_management import FolderManager
    \b
    >>> dummyFolderPath = FolderManager.instance().getTempFolder("dummyTempFolder")
    >>> print(dummyFolderPath)
    "/Users/X/.coretex/temp/dummyTempFolder"

Definition at line 118 of file folder_manager.py.

118  def getTempFolder(self, name: str) -> str:
119  """
120  Retrieves the path of the temp folder, does
121  not check if the folder exists or not
122 
123  Parameters
124  ----------
125  name : str
126  name of the folder
127 
128  Returns
129  -------
130  str -> path to the folder
131 
132  Example
133  -------
134  >>> from coretex.folder_management import FolderManager
135  \b
136  >>> dummyFolderPath = FolderManager.instance().getTempFolder("dummyTempFolder")
137  >>> print(dummyFolderPath)
138  "/Users/X/.coretex/temp/dummyTempFolder"
139  """
140 
141  return os.path.join(self.temp, name)
142 
The documentation for this class was generated from the following file: