ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-04-06 14:22:29 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Small edits (#821)

Browse Source
This commit is contained in:
pollfly 2024-04-07 11:16:04 +03:00 committed by GitHub
parent bb056d7b93
commit 56ce627b0d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/hyperdatasets/annotations.md
View File

@ -6,7 +6,7 @@ With ClearML Enterprise, annotations can be applied to video and image frames. [
two types of annotations: **Frame objects** and **Frame labels**. two types of annotations: **Frame objects** and **Frame labels**.
Annotation Tasks can be used to efficiently organize the annotation of frames in Hyper-Dataset versions (see Annotation Tasks can be used to efficiently organize the annotation of frames in Hyper-Dataset versions (see
[Annotations Task Page](webapp/webapp_annotator.md)). [Annotation Tasks](webapp/webapp_annotator.md)).
For information about how to view, create, and manage annotations using the WebApp, see [Annotating Images and Videos](webapp/webapp_annotator.md#annotating-images-and-video). For information about how to view, create, and manage annotations using the WebApp, see [Annotating Images and Videos](webapp/webapp_annotator.md#annotating-images-and-video).
@ -27,8 +27,7 @@ Frame labels are applied to an entire frame, not a region in a frame.
### Adding a Frame Object ### Adding a Frame Object
To add a frame object annotation to a SingleFrame, use the [`SingleFrame.add_annotation`](../references/hyperdataset/singleframe.md#add_annotation) To add a frame object annotation to a SingleFrame, use [`SingleFrame.add_annotation()`](../references/hyperdataset/singleframe.md#add_annotation):
method.
```python ```python
# a bounding box labeled "test" at x=10,y=10 with width of 30px and height of 20px # a bounding box labeled "test" at x=10,y=10 with width of 30px and height of 20px
@ -49,7 +48,8 @@ Enter the annotation's boundaries in one of the following ways:
Adding a frame label is similar to creating a frame object, except that coordinates don't need to be specified, since Adding a frame label is similar to creating a frame object, except that coordinates don't need to be specified, since
the whole frame is being referenced. the whole frame is being referenced.
Use the `SingleFrame.add_annotation` method, but use only the `labels` parameter. Use [`SingleFrame.add_annotation()`](../references/hyperdataset/singleframe.md#add_annotation), but specify only the
`labels` parameter:
```python ```python
# labels for the whole frame # labels for the whole frame

4
docs/hyperdatasets/frame_groups.md
View File

@ -78,8 +78,8 @@ myVersion.add_frames(frames)
### Accessing a FrameGroup ### Accessing a FrameGroup
To access a FrameGroup, use the `DatasetVersion.get_single_frame` method, just like when To access a FrameGroup, use [`DatasetVersion.get_single_frame()`](../references/hyperdataset/hyperdatasetversion.md#datasetversionget_single_frame),
[accessing a SingleFrame](single_frames.md#accessing-singleframes). just like when [accessing a SingleFrame](single_frames.md#accessing-singleframes):
```python ```python
# Get the FrameGroup # Get the FrameGroup

2
docs/hyperdatasets/single_frames.md
View File

@ -270,7 +270,7 @@ myDatasetversion.add_frames(frames)
### Accessing SingleFrames ### Accessing SingleFrames
To access a SingleFrame, use [`DatasetVersion.get_single_frame()`](../references/hyperdataset/hyperdatasetversion.md#datasetversionget_single_frame). To access a SingleFrame, use [`DatasetVersion.get_single_frame()`](../references/hyperdataset/hyperdatasetversion.md#datasetversionget_single_frame):
```python ```python
from allegroai import DatasetVersion from allegroai import DatasetVersion

6
docs/webapp/webapp_model_viewing.md
View File

@ -44,11 +44,11 @@ Hover over the model configuration area to access the following actions:
## Label Enumeration ## Label Enumeration
The **Label Enumeration** tab displays for each class label (“Label”) its name and enumerated value (“ID”). The **LABELS** tab displays for each class label (`Label`) its name and enumerated value (`ID`).
![Model label enumeration](../img/webapp_model_labels.png) ![Model label enumeration](../img/webapp_model_labels.png)
To modify / add / delete class labels (for Draft models), hover over the label table, then click EDIT. This opens the To modify / add / delete class labels (for *Draft* models), hover over the label table and click **EDIT**. This opens the
label editing window. label editing window.
![Model label editing](../img/webapp_model_labels_edit.png) ![Model label editing](../img/webapp_model_labels_edit.png)
@ -60,7 +60,7 @@ The **METADATA** tab lists the model's metadata entries, which consist of a key,
![Model metadata](../img/webapp_model_metadata.png) ![Model metadata](../img/webapp_model_metadata.png)
To modify / add / delete model metadata items, hover over Metadata, then click EDIT. This opens the Metadata editing To modify / add / delete model metadata items, hover over the metadata table and click **EDIT**. This opens the metadata editing
window. window.
![Model metadata editing](../img/webapp_model_metadata_edit.png) ![Model metadata editing](../img/webapp_model_metadata_edit.png)

2
sidebars.js
View File

@ -93,7 +93,7 @@ module.exports = {
'integrations/keras', 'integrations/keras_tuner', 'integrations/keras', 'integrations/keras_tuner',
'integrations/langchain', 'integrations/langchain',
'integrations/lightgbm', 'integrations/matplotlib', 'integrations/lightgbm', 'integrations/matplotlib',
'integrations/megengine', 'integrations/monai', 'integrations/mmcv', 'integrations/tao', 'integrations/megengine', 'integrations/mmcv', 'integrations/monai', 'integrations/tao',
'integrations/optuna', 'integrations/optuna',
'integrations/python_fire', 'integrations/pytorch', 'integrations/python_fire', 'integrations/pytorch',
'integrations/ignite', 'integrations/ignite',