ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions 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
5 changed files with 11 additions and 11 deletions
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**.
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).
@@ -27,8 +27,7 @@ Frame labels are applied to an entire frame, not a region in a frame.
### Adding a Frame Object
To add a frame object annotation to a SingleFrame, use the [`SingleFrame.add_annotation`](../references/hyperdataset/singleframe.md#add_annotation)
method.
To add a frame object annotation to a SingleFrame, use [`SingleFrame.add_annotation()`](../references/hyperdataset/singleframe.md#add_annotation):
```python
# 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
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
# labels for the whole frame

4
docs/hyperdatasets/frame_groups.md
View File

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

2
docs/hyperdatasets/single_frames.md
View File

@@ -270,7 +270,7 @@ myDatasetversion.add_frames(frames)
### 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
from allegroai import DatasetVersion