Skip to content

Commit 332f9fa

Browse files
milankuresmilankures
committed
Docs: Added missed imports of DatasetType; change display_config from bool to text variant
1 parent b006301 commit 332f9fa

File tree

5 files changed

+20
-19
lines changed

5 files changed

+20
-19
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ For detailed examples refer to [`Tutorial notebooks`](https://github.com/CESNET/
7171

7272
```python
7373
from cesnet_tszoo.datasets import CESNET_TimeSeries24
74-
from cesnet_tszoo.utils.enums import SourceType, AgreggationType
74+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
7575
from cesnet_tszoo.configs import TimeBasedConfig
7676

7777
dataset = CESNET_TimeSeries24.get_dataset(data_root="/some_directory/", source_type=SourceType.INSTITUTIONS, aggregation=AgreggationType.AGG_1_DAY, dataset_type=DatasetType.TIME_BASED)
@@ -93,7 +93,7 @@ Time-based datasets are configured with [`TimeBasedConfig`](https://cesnet.githu
9393
#### Using [`DisjointTimeBasedCesnetDataset`](https://cesnet.github.io/cesnet-tszoo/reference_disjoint_time_based_cesnet_dataset/) dataset
9494
```python
9595
from cesnet_tszoo.datasets import CESNET_TimeSeries24
96-
from cesnet_tszoo.utils.enums import SourceType, AgreggationType
96+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
9797
from cesnet_tszoo.configs import DisjointTimeBasedConfig
9898

9999
dataset = CESNET_TimeSeries24.get_dataset("/some_directory/", source_type=SourceType.INSTITUTIONS, aggregation=AgreggationType.AGG_1_DAY, dataset_type=DatasetType.DISJOINT_TIME_BASED)
@@ -118,7 +118,7 @@ Disjoint-time-based datasets are configured with [`DisjointTimeBasedConfig`](htt
118118

119119
```python
120120
from cesnet_tszoo.datasets import CESNET_TimeSeries24
121-
from cesnet_tszoo.utils.enums import SourceType, AgreggationType
121+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
122122
from cesnet_tszoo.configs import SeriesBasedConfig
123123

124124
dataset = CESNET_TimeSeries24.get_dataset(data_root="/some_directory/", source_type=SourceType.INSTITUTIONS, aggregation=AgreggationType.AGG_1_DAY, dataset_type=DatasetType.SERIES_BASED)

‎docs/benchmarks_tutorial.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Benchmarks can consist of various parts:
1212
- identifier of used config
1313
- identifier of used annotations (for each AnnotationType)
1414
- identifier of related_results (only available for premade benchmarks)
15-
- Used SourceType and AggregationType
15+
- Used SourceType, AggregationType and DatasetType
1616
- Database name (here it would be CESNET_TimeSeries24)
1717
- Whether config or annotations are built-in
1818

@@ -30,12 +30,12 @@ from cesnet_tszoo.benchmarks import load_benchmark
3030
# Can get related_results with `get_related_results` method.
3131
# Method `get_related_results` returns pandas Dataframe.
3232
benchmark = load_benchmark(identifier="2e92831cb502", data_root="/some_directory/")
33-
dataset = benchmark.get_initialized_dataset(display_config_details=True, check_errors=False, workers="config")
33+
dataset = benchmark.get_initialized_dataset(display_config_details="text", check_errors=False, workers="config")
3434

3535
# Imports custom benchmark
3636
# Looks for benchmark at: `os.path.join("/some_directory/", "tszoo", "benchmarks", identifier)`
3737
benchmark = load_benchmark(identifier="test2", data_root="/some_directory/")
38-
dataset = benchmark.get_initialized_dataset(display_config_details=True, check_errors=False, workers="config")
38+
dataset = benchmark.get_initialized_dataset(display_config_details="text", check_errors=False, workers="config")
3939

4040
```
4141

@@ -55,13 +55,14 @@ dataset = benchmark.get_initialized_dataset(display_config_details=True, check_e
5555
```python
5656

5757
from cesnet_tszoo.datasets import CESNET_TimeSeries24
58+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
5859
from cesnet_tszoo.configs import TimeBasedConfig
5960

6061
time_based_dataset = CESNET_TimeSeries24.get_dataset(data_root="/some_directory/", source_type=SourceType.IP_ADDRESSES_FULL, aggregation=AgreggationType.AGG_1_DAY, dataset_type=DatasetType.TIME_BASED, display_details=True)
6162
config = TimeBasedConfig([1548925, 443967], train_time_period=1.0, features_to_take=["n_flows", "n_packets", "n_bytes"], transform_with=None)
6263

6364
# Call on time-based dataset to use created config -> must be done before saving exporting benchmark
64-
time_based_dataset.set_dataset_config_and_initialize(config, workers=0, display_config_details=True)
65+
time_based_dataset.set_dataset_config_and_initialize(config, workers=0, display_config_details="text")
6566

6667
time_based_dataset.save_benchmark(identifier="test1", force_write=True)
6768

@@ -84,13 +85,13 @@ from cesnet_tszoo.configs import TimeBasedConfig
8485

8586
config = TimeBasedConfig([1548925, 443967], train_time_period=1.0, features_to_take=["n_flows", "n_packets", "n_bytes"], transform_with=None)
8687

87-
time_based_dataset.set_dataset_config_and_initialize(config, workers=0, display_config_details=True)
88+
time_based_dataset.set_dataset_config_and_initialize(config, workers=0, display_config_details="text")
8889

8990
# Exports config
9091
time_based_dataset.save_config(identifier="test_config1", create_with_details_file=True, force_write=True)
9192

9293
# Imports custom config
93-
time_based_dataset.import_config(identifier="test_config1", display_config_details=True, workers="config")
94+
time_based_dataset.import_config(identifier="test_config1", display_config_details="text", workers="config")
9495

9596
```
9697

‎docs/getting_started.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
### Download a dataset
99
```python
1010
from cesnet_tszoo.datasets import CESNET_TimeSeries24
11-
from cesnet_tszoo.utils.enums import SourceType, AgreggationType
11+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
1212

1313
dataset = CESNET_TimeSeries24.get_dataset("/some_directory/", source_type=SourceType.INSTITUTIONS, aggregation=AgreggationType.AGG_1_DAY, dataset_type=DatasetType.TIME_BASED)
1414
```
@@ -47,7 +47,7 @@ Set up logging to get more information from the package.
4747
#### Using [`TimeBasedCesnetDataset`](reference_time_based_cesnet_dataset.md#cesnet_tszoo.datasets.time_based_cesnet_dataset.TimeBasedCesnetDataset) dataset
4848
```python
4949
from cesnet_tszoo.datasets import CESNET_TimeSeries24
50-
from cesnet_tszoo.utils.enums import SourceType, AgreggationType
50+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
5151
from cesnet_tszoo.configs import TimeBasedConfig
5252

5353
dataset = CESNET_TimeSeries24.get_dataset("/some_directory/", source_type=SourceType.INSTITUTIONS, aggregation=AgreggationType.AGG_1_DAY, dataset_type=DatasetType.TIME_BASED)
@@ -71,7 +71,7 @@ Can load data using:
7171
#### Using [`DisjointTimeBasedCesnetDataset`](reference_disjoint_time_based_cesnet_dataset.md#cesnet_tszoo.datasets.disjoint_time_based_cesnet_dataset.DisjointTimeBasedCesnetDataset) dataset
7272
```python
7373
from cesnet_tszoo.datasets import CESNET_TimeSeries24
74-
from cesnet_tszoo.utils.enums import SourceType, AgreggationType
74+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
7575
from cesnet_tszoo.configs import DisjointTimeBasedConfig
7676

7777
dataset = CESNET_TimeSeries24.get_dataset("/some_directory/", source_type=SourceType.INSTITUTIONS, aggregation=AgreggationType.AGG_1_DAY, dataset_type=DatasetType.DISJOINT_TIME_BASED)
@@ -97,7 +97,7 @@ Can load data using:
9797
#### Using [`SeriesBasedCesnetDataset`](reference_series_based_cesnet_dataset.md#cesnet_tszoo.datasets.series_based_cesnet_dataset.SeriesBasedCesnetDataset) dataset
9898
```python
9999
from cesnet_tszoo.datasets import CESNET_TimeSeries24
100-
from cesnet_tszoo.utils.enums import SourceType, AgreggationType
100+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
101101
from cesnet_tszoo.configs import SeriesBasedConfig
102102

103103
dataset = CESNET_TimeSeries24.get_dataset("/some_directory/", source_type=SourceType.INSTITUTIONS, aggregation=AgreggationType.AGG_1_DAY, dataset_type=DatasetType.SERIES_BASED)

‎docs/using_datasets.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ from cesnet_tszoo.benchmarks import load_benchmark
1717

1818
# Imports built-in benchmark
1919
benchmark = load_benchmark(identifier="2e92831cb502", data_root="/some_directory/")
20-
dataset = benchmark.get_initialized_dataset(display_config_details=True, check_errors=False, workers="config")
20+
dataset = benchmark.get_initialized_dataset(display_config_details="text", check_errors=False, workers="config")
2121

2222
# Imports custom benchmark
2323
benchmark = load_benchmark(identifier="test2", data_root="/some_directory/")
24-
dataset = benchmark.get_initialized_dataset(display_config_details=True, check_errors=False, workers="config")
24+
dataset = benchmark.get_initialized_dataset(display_config_details="text", check_errors=False, workers="config")
2525

2626
```
2727

@@ -36,7 +36,7 @@ from cesnet_tszoo.configs import TimeBasedConfig # For time-based dataset
3636
from cesnet_tszoo.configs import SeriesBasedConfig # For series-based dataset
3737
from cesnet_tszoo.configs import DisjointTimeBasedConfig # For disjoint-time-based dataset
3838

39-
from cesnet_tszoo.utils.enums import AgreggationType, SourceType # Used for specifying which dataset to use
39+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType # Used for specifying which dataset to use
4040
from cesnet_tszoo.datasets import CESNET_TimeSeries24
4141

4242
# Time-based

‎docs/utilities.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ logging.basicConfig(
2626
- Recommended to call at least once after download
2727

2828
```python
29-
from cesnet_tszoo.utils.enums import AgreggationType, SourceType
29+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
3030
from cesnet_tszoo.datasets import CESNET_TimeSeries24
3131

3232
# Can be called at dataset creation
@@ -71,7 +71,7 @@ Returns all data in dictionary related to set.
7171
from cesnet_tszoo.configs import TimeBasedConfig
7272

7373
config = TimeBasedConfig(20, train_time_period=0.5)
74-
time_based_dataset.set_dataset_config_and_initialize(config, workers=0, display_config_details=False)
74+
time_based_dataset.set_dataset_config_and_initialize(config, workers=0, display_config_details=None)
7575

7676
time_based_dataset.get_data_about_set(about=SplitType.TRAIN)
7777

@@ -148,7 +148,7 @@ dataset.plot(ts_id=10, plot_type="line", features="n_flows", feature_per_plot=Tr
148148
- You can check whether dataset has additional data, with method `display_dataset_details`.
149149

150150
```python
151-
from cesnet_tszoo.utils.enums import AgreggationType, SourceType
151+
from cesnet_tszoo.utils.enums import SourceType, AgreggationType, DatasetType
152152
from cesnet_tszoo.datasets import CESNET_TimeSeries24
153153

154154
time_based_dataset = CESNET_TimeSeries24.get_dataset(data_root="/some_directory/", source_type=SourceType.IP_ADDRESSES_SAMPLE, aggregation=AgreggationType.AGG_1_DAY, dataset_type=DatasetType.TIME_BASED, display_details=True)

0 commit comments

Comments
 (0)