Coretex
Public Member Functions | List of all members
coretex.entities.dataset.dataset.Dataset Class Reference
Inheritance diagram for coretex.entities.dataset.dataset.Dataset:
coretex.entities.dataset.local_dataset.LocalDataset coretex.entities.dataset.network_dataset.NetworkDataset coretex.entities.dataset.custom_dataset.local_custom_dataset.LocalCustomDataset coretex.entities.dataset.image_dataset.local_image_dataset.LocalImageDataset coretex.entities.dataset.sequence_dataset.local_sequence_dataset.LocalSequenceDataset coretex.entities.dataset.custom_dataset.custom_dataset.CustomDataset coretex.entities.dataset.image_dataset.image_dataset.ImageDataset coretex.entities.dataset.sequence_dataset.sequence_dataset.SequenceDataset

Public Member Functions

int count (self)
 
bool rename (self, str name)
 
Optional[SampleType] getSample (self, str name)
 

Detailed Description

    Represents the generic class Dataset
    Includes methods that can be used by any instance of Dataset
    and abstract methods that must be implemented by any subclass

    Properties
    ----------
    name : str
        name of dataset
    samples : List[SampleType]
        list of samples

Definition at line 29 of file dataset.py.

Member Function Documentation

◆ count()

int coretex.entities.dataset.dataset.Dataset.count (   self) 
    Returns
    -------
    int -> number of samples in this dataset

Definition at line 48 of file dataset.py.

48  def count(self) -> int:
49  """
50  Returns
51  -------
52  int -> number of samples in this dataset
53  """
54 
55  return len(self.samples)
56 

◆ getSample()

Optional[SampleType] coretex.entities.dataset.dataset.Dataset.getSample (   self,
str  name 
) 
    Retrieves sample which matches the provided name

    Parameters
    ----------
    name : str
        name of sample

    Returns
    -------
    Optional[SampleType] -> sample object

Definition at line 90 of file dataset.py.

90  def getSample(self, name: str) -> Optional[SampleType]:
91  """
92  Retrieves sample which matches the provided name
93 
94  Parameters
95  ----------
96  name : str
97  name of sample
98 
99  Returns
100  -------
101  Optional[SampleType] -> sample object
102  """
103 
104  for sample in self.samples:
105  # startswith must be used since if we import sample
106  # with the same name twice, the second one will have
107  # suffix with it's serial number
108  if sample.name.startswith(name):
109  return sample
110 
111  return None
112 

◆ rename()

bool coretex.entities.dataset.dataset.Dataset.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 in coretex.entities.dataset.network_dataset.NetworkDataset.

Definition at line 66 of file dataset.py.

66  def rename(self, name: str) -> bool:
67  """
68  Renames the dataset, if the provided name is
69  different from the current name
70 
71  Parameters
72  ----------
73  name : str
74  new dataset name
75 
76  Returns
77  -------
78  bool -> True if dataset was renamed, False if dataset was not renamed
79  """
80 
81  if not isEntityNameValid(name):
82  raise ValueError(">> [Coretex] Dataset name is invalid. Requirements: alphanumeric characters (\"a-z\", and \"0-9\") and dash (\"-\") with length between 3 to 50")
83 
84  if self.name == name:
85  return False
86 
87  self.name = name
88  return True
89 
The documentation for this class was generated from the following file: