From 68c1df336f300c3bd264b5b86fff51d81515088a Mon Sep 17 00:00:00 2001 From: Dusko Vesic Date: Tue, 16 Jul 2024 14:42:00 +0200 Subject: [PATCH 1/3] Documentation update for createCacheDataset() --- coretex/entities/dataset/network_dataset.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/coretex/entities/dataset/network_dataset.py b/coretex/entities/dataset/network_dataset.py index 413e3766..7fad979d 100644 --- a/coretex/entities/dataset/network_dataset.py +++ b/coretex/entities/dataset/network_dataset.py @@ -271,6 +271,20 @@ 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 + >>> dummyDataset = NetworkDataset.createDataset("dummyDataset", dependencies, 123) """ if not isEntityNameValid(prefix): From 8d5c203f88d11462af60512409848d769f968c19 Mon Sep 17 00:00:00 2001 From: Dusko Vesic Date: Wed, 24 Jul 2024 09:14:26 +0200 Subject: [PATCH 2/3] code improvements --- coretex/entities/dataset/network_dataset.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/coretex/entities/dataset/network_dataset.py b/coretex/entities/dataset/network_dataset.py index 7fad979d..ce17156b 100644 --- a/coretex/entities/dataset/network_dataset.py +++ b/coretex/entities/dataset/network_dataset.py @@ -284,7 +284,7 @@ def createCacheDataset(cls, prefix: str, dependencies: List[str], projectId: int ------- >>> from coretex import NetworkDataset \b - >>> dummyDataset = NetworkDataset.createDataset("dummyDataset", dependencies, 123) + >>> dummyDataset = NetworkDataset.createCacheDataset("dummyDataset", dependencies, 123) """ if not isEntityNameValid(prefix): From cbbadc2028b64e2921142eba860c2313d0c18f22 Mon Sep 17 00:00:00 2001 From: Dusko Vesic Date: Wed, 24 Jul 2024 09:31:14 +0200 Subject: [PATCH 3/3] code improvements --- coretex/entities/dataset/network_dataset.py | 1 + 1 file changed, 1 insertion(+) diff --git a/coretex/entities/dataset/network_dataset.py b/coretex/entities/dataset/network_dataset.py index ce17156b..8635a4ac 100644 --- a/coretex/entities/dataset/network_dataset.py +++ b/coretex/entities/dataset/network_dataset.py @@ -284,6 +284,7 @@ def createCacheDataset(cls, prefix: str, dependencies: List[str], projectId: int ------- >>> from coretex import NetworkDataset \b + >>> dependencies = [str(projectId), str(index), str(parameter)] >>> dummyDataset = NetworkDataset.createCacheDataset("dummyDataset", dependencies, 123) """