Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: how to use UI features #5012

Closed
wants to merge 7 commits into from
Closed

Conversation

sdiazlor
Copy link
Contributor

Description

  • How to guide
  • Fix popular issues gh token requirement
  • Fix links and reference links due to the renaming

Closes #4927

Type of change

(Remember to title the PR according to the type of change)

  • Documentation update

How Has This Been Tested

(Please describe the tests that you ran to verify your changes.)

mkdocs serve


### General progress view

On the main page, before accessing the dataset, you can see the general progress of the annotation task. This is indicated in the `Global progress` column that shows the number of remaining records to be annotated and a progress bar. The progress bar displays the percentage and number of records submitted, conflicting (i.e. those with overlap), discarded and pending by hovering your mouse over it.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this is a bit picky, but is there a reason why it used "left" and not "pending" aligned with the rest of the record status?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Picky is fundamental! The global progress in dataset list is not exactly reflecting the records status we have into the dataset, Its more about providing a quick look on how its going the task. In any case with the task distribution V1 (Release 2.1) This Global progress will be probably simplified to Completed vs Left.

Copy link
Member

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some small comments.

argilla/docs/how_to_guides/annotate.md Show resolved Hide resolved
argilla/docs/how_to_guides/annotate.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/annotate.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/annotate.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/annotate.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/annotate.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/annotate.md Outdated Show resolved Hide resolved
@sdiazlor sdiazlor marked this pull request as draft June 14, 2024 15:45
Base automatically changed from feat/v2.0.0 to develop June 19, 2024 13:46
@sdiazlor sdiazlor closed this Jun 19, 2024
@sdiazlor sdiazlor linked an issue Jun 19, 2024 that may be closed by this pull request
@sdiazlor sdiazlor deleted the docs/how-to-use-ui-features branch July 29, 2024 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[v2 DOCS] How to use UI features
3 participants