ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 05:20:07 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Edit DataView page (#800)

Browse Source
This commit is contained in:
pollfly 2024-03-14 10:05:51 +02:00 committed by GitHub
parent 68b8b524f7
commit 74fee2101b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/hyperdatasets/dataviews.md
View File

@ -149,7 +149,7 @@ myDataView = DataView(iteration_order=IterationOrder.random, iteration_infinite=
### Adding Queries
To add a query to a DataView, use the [`DataView.add_query`](../references/hyperdataset/dataview.md#add_query) method
To add a query to a DataView, use [`DataView.add_query()`](../references/hyperdataset/dataview.md#add_query)
and specify Dataset versions, ROI and/or frame queries, and other criteria.
The `dataset_name` and `version_name` arguments specify the Dataset Version. The `roi_query` and `frame_query` arguments
@ -160,8 +160,8 @@ specify the queries.
Multiple queries can be added to the same or different Dataset versions, each query with the same or different ROI
and/or frame queries.
You can retrieve the Dataview frames using [`DataView.to_list`](../references/hyperdataset/dataview.md#to_list),
[`DataView.to_dict`](../references/hyperdataset/dataview.md#to_dict), or [`DataView.get_iterator`](../references/hyperdataset/dataview.md#get_iterator)
You can retrieve the Dataview frames using [`DataView.to_list()`](../references/hyperdataset/dataview.md#to_list),
[`DataView.to_dict()`](../references/hyperdataset/dataview.md#to_dict), or [`DataView.get_iterator()`](../references/hyperdataset/dataview.md#get_iterator)
(see [Accessing Frames](#accessing-frames)).
#### ROI Queries:
@ -172,7 +172,7 @@ This example is an ROI query filtering for frames containing at least one ROI wi
```python
# Create a Dataview object for an iterator that randomly returns frames according to queries
myDataView = DataView(iteration_order=IterationOrder.random, iteration_infinite=True)
myDataView = DataView(iteration_order=IterationOrder.random, iteration_infinite=False)
# Add a query for a Dataset version
myDataView.add_query(
@ -332,7 +332,7 @@ This example demonstrates creating a DataView and setting its parameters to iter
```python
# Create a Dataview object for an iterator for frames
myDataView = DataView(iteration_order=IterationOrder.random, iteration_infinite=True)
myDataView = DataView(iteration_order=IterationOrder.random, iteration_infinite=False)
# Set Iteration Parameters (overrides parameters in constructing the DataView object
myDataView.set_iteration_parameters(
@ -499,7 +499,7 @@ Dataview objects can be retrieved by the Dataview ID or name using the [`DataVie
class method.
```python
my_dataview = DataView.get(dataview_id='12344kg2p3hf8')
my_dataview = DataView.get(dataview_id='<dataview_id>')
```
Access the Dataview's frames as a python list, dictionary, or through a pythonic iterator.