Inheritance diagram for coretex.coretex.dataset.network_dataset.NetworkDataset:

Public Member Functions
Path	path (self)

Optional[Self]	createDataset (cls, str name, int spaceId, Optional[List[int]] sampleIds=None, Optional[Dict[str, Any]] meta=None)

None	download (self, bool ignoreCache=False)

bool	add (self, SampleType sample)

bool	rename (self, str name)

Public Member Functions inherited from coretex.coretex.dataset.dataset.Dataset
int	count (self)

Optional[SampleType]	getSample (self, str name)

Detailed Description

    Represents the base class for all Dataset classes which are
    comunicating with Coretex.ai

    Properties
    ----------
    createdOn : datetime
        creation date of dataset
    createdById : str
        id of created dataset id
    isLocked : bool
        availabilty of dataset for modifications

Definition at line 36 of file network_dataset.py.

Member Function Documentation

◆ add()

bool coretex.coretex.dataset.network_dataset.NetworkDataset.add	(		self,
		SampleType	sample
	)

    Adds the specified sample into the dataset

    Parameters
    ----------
    sample : SampleType
sample which should be added into the dataset

    Returns
    -------
    bool -> True if sample was added, False if sample was not added

Reimplemented from coretex.coretex.dataset.dataset.Dataset.

Definition at line 189 of file network_dataset.py.

     def add(self, sample: SampleType) -> bool:
         if self.isLocked or sample.isDeleted:
             return False
  
         success = self.update({
             "sessions": [sample.id]
         })
  
         if success:
             return super().add(sample)
  
         return success
  

◆ createDataset()

Optional[Self] coretex.coretex.dataset.network_dataset.NetworkDataset.createDataset	(		cls,
		str	name,
		int	spaceId,
		Optional[List[int]]	sampleIds = `None`,
		Optional[Dict[str, Any]]	meta = `None`
	)

    Creates a new dataset with the provided name, type
    and samples (if present, samples are not required)

    Parameters
    ----------
    name : str
dataset name
    spaceId : int
space for which the dataset will be created
    samplesIds : List[int]
samples which should be added to dataset (if present)

    Returns
    -------
    The created dataset object or None if creation failed

    Example
    -------
    >>> from coretex import NetworkDataset
    \b
    >>> dummyDataset = NetworkDataset.createDataset("dummyDataset", 123)
    >>> if dummyDataset is not None:
    print("Dataset created successfully")

Definition at line 107 of file network_dataset.py.

     def createDataset(
         cls,
         name: str,
         spaceId: int,
         sampleIds: Optional[List[int]] = None,
         meta: Optional[Dict[str, Any]] = None
     ) -> Optional[Self]:
  
         """
             Creates a new dataset with the provided name, type
             and samples (if present, samples are not required)
  
             Parameters
             ----------
             name : str
                 dataset name
             spaceId : int
                 space for which the dataset will be created
             samplesIds : List[int]
                 samples which should be added to dataset (if present)
  
             Returns
             -------
             The created dataset object or None if creation failed
  
             Example
             -------
             >>> from coretex import NetworkDataset
             \b
             >>> dummyDataset = NetworkDataset.createDataset("dummyDataset", 123)
             >>> if dummyDataset is not None:
                     print("Dataset created successfully")
         """
  
         if sampleIds is None:
             sampleIds = []
  
         return cls.create({
             "name": name,
             "project_id": spaceId,
             "sessions": sampleIds,
             "meta": meta
         })
  

◆ download()

None coretex.coretex.dataset.network_dataset.NetworkDataset.download	(		self,
		bool	ignoreCache = `False`
	)

    Downloads dataset from Coretex

    Parameters
    ----------
    ignoreCache : bool
if dataset is already downloaded and ignoreCache
is True it will be downloaded again (not required)

    Example
    -------
    >>> from coretex import NetworkDataset
    \b
    >>> dummyDataset = NetworkDataset.fetchById(1023)
    >>> dummyDataset.download()
    >> [Coretex] Downloading dataset: [==>...........................] - 10%

Reimplemented from coretex.coretex.dataset.dataset.Dataset.

Definition at line 151 of file network_dataset.py.

     def download(self, ignoreCache: bool = False) -> None:
         """
             Downloads dataset from Coretex
  
             Parameters
             ----------
             ignoreCache : bool
                 if dataset is already downloaded and ignoreCache
                 is True it will be downloaded again (not required)
  
             Example
             -------
             >>> from coretex import NetworkDataset
             \b
             >>> dummyDataset = NetworkDataset.fetchById(1023)
             >>> dummyDataset.download()
             >> [Coretex] Downloading dataset: [==>...........................] - 10%
         """
  
         self.path.mkdir(exist_ok = True)
  
         def sampleDownloader(sample: SampleType) -> None:
             downloadSuccess = sample.download(ignoreCache)
             if not downloadSuccess:
                 return
  
             symlinkPath = self.path / f"{sample.id}.zip"
             if not symlinkPath.exists():
                 os.symlink(sample.zipPath, symlinkPath)
  
         processor = MultithreadedDataProcessor(
             self.samples,
             sampleDownloader,
             title = "Downloading dataset"
         )
  
         processor.process()
  

◆ path()

Path coretex.coretex.dataset.network_dataset.NetworkDataset.path ( self )

    Retrieves path of dataset

    Returns
    -------
    Path -> path of dataset

Reimplemented from coretex.coretex.dataset.dataset.Dataset.

Definition at line 62 of file network_dataset.py.

     def path(self) -> Path:
         """
             Retrieves path of dataset
  
             Returns
             -------
             Path -> path of dataset
         """
  
         return FolderManager.instance().datasetsFolder / str(self.id)
  

◆ rename()

bool coretex.coretex.dataset.network_dataset.NetworkDataset.rename	(		self,
		str	name
	)

    Renames the dataset, if the provided name is
    different from the current name

    Parameters
    ----------
    name : str
new dataset name

    Returns
    -------
    bool -> True if dataset was renamed, False if dataset was not renamed

Reimplemented from coretex.coretex.dataset.dataset.Dataset.

Definition at line 202 of file network_dataset.py.

     def rename(self, name: str) -> bool:
         success = self.update({
             "name": name
         })
  
         if success:
             return super().rename(name)
  
         return success

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

src/coretex/coretex/dataset/network_dataset.py

Public Member Functions

Detailed Description

Member Function Documentation

◆ add()

◆ createDataset()

◆ download()

◆ path()

◆ rename()