Skip to content

Commit

Permalink
Merge pull request #238 from duskovesic/documentation
Browse files Browse the repository at this point in the history
Documentation update for createCacheDataset()
  • Loading branch information
dule1322 authored Jul 30, 2024
2 parents 542f343 + cbbadc2 commit be2ecf2
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions coretex/entities/dataset/network_dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,21 @@ def createCacheDataset(cls, prefix: str, dependencies: List[str], projectId: int
parameters which affect the contents of the cache
projectId : int
project for which the dataset will be created
Returns
-------
The created dataset object
Raises
------
ValueError -> If prefix of the name is invalid or if failed to create cache dataset
Example
-------
>>> from coretex import NetworkDataset
\b
>>> dependencies = [str(projectId), str(index), str(parameter)]
>>> dummyDataset = NetworkDataset.createCacheDataset("dummyDataset", dependencies, 123)
"""

if not isEntityNameValid(prefix):
Expand Down

0 comments on commit be2ecf2

Please sign in to comment.