Skip to content

Commit 24231b9

Browse files
committed
Add additional comments and add ProjectOverview to readthedocs
1 parent a862909 commit 24231b9

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

docs/labelbox/project-overview.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
ProjectOverview
2+
===============================================================================================
3+
4+
.. automodule:: labelbox.schema.project-overview
5+
:members:
6+
:show-inheritance:

libs/labelbox/src/labelbox/schema/project_overview.py

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,35 @@
11
from typing import Dict, Optional
22
from labelbox import pydantic_compat
33

4+
from typing import Dict
5+
import pydantic_compat
6+
47
class ProjectOverview(pydantic_compat.BaseModel):
58
"""
6-
Class that represents a project overview as displayed in the UI
9+
Class that represents a project summary as displayed in the UI, in Annotate,
10+
under the "Overview" tab of a particular project.
11+
712
All attributes represent the number of data rows in the corresponding state.
813
The `in_review` attribute is a dictionary where the keys are the queue names
9-
and the values are the number of data rows in that queue.
14+
and the values are the number of data rows in that queue.
15+
16+
Attributes:
17+
Representing existing fields from the Overview tag (UI names in parentheses):
18+
19+
to_label (int): The number of data rows that are yet to be labeled (To Label).
20+
in_review (Dict[str, int]): A dictionary where the keys are the queue names .
21+
and the values are the number of data rows in that queue. (In Review)
22+
in_rework (int): The number of data rows that are in the Rework queue (In Rework).
23+
skipped (int): The number of data rows that have been skipped (Skipped).
24+
done (int): The number of data rows that have been marked as Done (Done).
25+
issues (int): The number of data rows with associated issues (Issues).
26+
27+
Additional values:
28+
29+
labeled (int): The number of data rows that have been labeled.
30+
all_in_data_rows (int): The total number of data rows in the project.
1031
"""
11-
to_label: int
32+
to_label: int
1233
in_review: Dict[str, int]
1334
in_rework: int
1435
skipped: int

0 commit comments

Comments
 (0)