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: DOC-205: Document changes to ML backend #5642

Merged
merged 24 commits into from
Apr 18, 2024
Merged

Conversation

caitlinwheeless
Copy link
Contributor

@caitlinwheeless caitlinwheeless commented Mar 28, 2024

Updates to ML backend

This affects:

  • Community docs
  • Enterprise docs

@github-actions github-actions bot added the docs label Mar 28, 2024
Copy link

netlify bot commented Mar 28, 2024

Deploy Preview for label-studio-docs-new-theme ready!

Name Link
🔨 Latest commit 7a7d892
🔍 Latest deploy log https://app.netlify.com/sites/label-studio-docs-new-theme/deploys/661f05cc9c7c790008f76e1d
😎 Deploy Preview https://deploy-preview-5642--label-studio-docs-new-theme.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Mar 28, 2024

Deploy Preview for heartex-docs ready!

Name Link
🔨 Latest commit 7a7d892
🔍 Latest deploy log https://app.netlify.com/sites/heartex-docs/deploys/661f05cc0b88b00008c3edae
😎 Deploy Preview https://deploy-preview-5642--heartex-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@caitlinwheeless caitlinwheeless marked this pull request as ready for review April 3, 2024 19:08
docs/source/guide/active_learning.md Outdated Show resolved Hide resolved
docs/source/guide/active_learning.md Outdated Show resolved Hide resolved
docs/source/guide/ml.md Outdated Show resolved Hide resolved
docs/source/guide/ml.md Show resolved Hide resolved
docs/source/guide/ml.md Outdated Show resolved Hide resolved
docs/source/guide/project_settings.md Outdated Show resolved Hide resolved
docs/source/guide/project_settings.md Outdated Show resolved Hide resolved
docs/source/guide/project_settings_lse.md Outdated Show resolved Hide resolved
docs/source/guide/project_settings_lse.md Outdated Show resolved Hide resolved
docs/source/guide/project_settings_lse.md Outdated Show resolved Hide resolved

</dl>
From here you can view predictions that have been imported or generated when executing the **Batch Predictions** action from the Data Manager. For more information on using predictions, see [Import pre-annotated data into Label Studio](predictions).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated - double check if correct

Copy link
Collaborator

Choose a reason for hiding this comment

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

it is called Batch Predictions in LSE and Retrieve Predictions in LS

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the LSE version of the Project Settings page, so I think it's correct. I don't mention the action in the LS version - I will update there.

docs/source/guide/ml.md Outdated Show resolved Hide resolved

For image labeling, you can update your labeling configuration to include `smart="true"` option for the type of labeling you're performing. Smart tools appear by default if auto-annotation is enabled. If you only want the smart option to appear and don't want to perform manual labeling at all, use `smartOnly="true"`.
Smart tools duplicate the tools that you have set up to use through your labeling configuration (e.g. rectangles) to allow interaction with the ML backend. Smart tools are currently for Rectangle, Ellipse, Polygon, Keypoint, and Brush tags.
Copy link
Collaborator

Choose a reason for hiding this comment

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

shall we provide exact labeling tags instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added tag formatting and links to the appropriate tag pages


</dl>
From here you can view predictions that have been imported or generated when executing the **Batch Predictions** action from the Data Manager. For more information on using predictions, see [Import pre-annotated data into Label Studio](predictions).
Copy link
Collaborator

Choose a reason for hiding this comment

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

it is called Batch Predictions in LSE and Retrieve Predictions in LS

@niklub niklub merged commit ab883c3 into develop Apr 18, 2024
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants