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: LSDV-5358: Add Generative AI templates #4486

Merged
merged 16 commits into from
Jul 13, 2023
Merged

Conversation

niklub
Copy link
Collaborator

@niklub niklub commented Jul 7, 2023

PR fulfills these requirements

  • Commit message(s) and PR title follows the format [fix|feat|ci|chore|doc]: TICKET-ID: Short description of change made ex. fix: DEV-XXXX: Removed inconsistent code usage causing intermittent errors
  • Tests for the changes have been added/updated (for bug fixes/features)
  • Docs have been added/updated (for bug fixes/features)
  • Best efforts were made to ensure docs/code are concise and coherent (checked for spelling/grammatical errors, commented out code, debug logs etc.)
  • Self-reviewed and ran all changes on a local instance (for bug fixes/features)

Change has impacts in these area(s)

(check all that apply)

  • Product design
  • Backend (Database)
  • Backend (API)
  • Frontend

Describe the reason for change

(link to issue, supportive screenshots etc.)

What does this fix?

(if this is a bug fix)

What is the new behavior?

(if this is a breaking or feature change)

What is the current behavior?

(if this is a breaking or feature change)

What libraries were added/updated?

(list all with version changes)

Does this change affect performance?

(if so describe the impacts positive or negative)

Does this change affect security?

(if so describe the impacts positive or negative)

What alternative approaches were there?

(briefly list any if applicable)

What feature flags were used to cover this change?

(briefly list any if applicable)

Does this PR introduce a breaking change?

(check only one)

  • Yes, and covered entirely by feature flag(s)
  • Yes, and covered partially by feature flag(s)
  • No
  • Not sure (briefly explain the situation below)

What level of testing was included in the change?

(check all that apply)

  • e2e
  • integration
  • unit

Which logical domain(s) does this change affect?

(for bug fixes/features, be as precise as possible. ex. Authentication, Annotation History, Review Stream etc.)

@netlify
Copy link

netlify bot commented Jul 7, 2023

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

Name Link
🔨 Latest commit 66466c5
🔍 Latest deploy log https://app.netlify.com/sites/label-studio-docs-new-theme/deploys/64b0573c5925c70008eff2aa
😎 Deploy Preview https://deploy-preview-4486--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.

@netlify
Copy link

netlify bot commented Jul 7, 2023

Deploy Preview for heartex-docs ready!

Name Link
🔨 Latest commit 66466c5
🔍 Latest deploy log https://app.netlify.com/sites/heartex-docs/deploys/64b0573c17701e000818bd5c
😎 Deploy Preview https://deploy-preview-4486--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.

@erinmikailstaples erinmikailstaples self-assigned this Jul 7, 2023
@erinmikailstaples erinmikailstaples added documentation Improvements or additions to documentation docs labels Jul 7, 2023
@erinmikailstaples
Copy link
Contributor

erinmikailstaples commented Jul 10, 2023

Updated items in the latest commit — I didn't catch the spacing error that @hogepodge did on preview, but I mostly cleaned up grammar, added links, and corrected typos in the updates made.

LGTM! 🚀

@niklub — ready when you are

Copy link
Contributor

@erinmikailstaples erinmikailstaples left a comment

Choose a reason for hiding this comment

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

Reviewed the formatting in preview and with @huguestennier's adjustments going to give it another review here shortly to make sure the docs are all consistent.

@niklub LGTM otherwise 🚀

docs/source/templates/get_started.md Outdated Show resolved Hide resolved
@erinmikailstaples erinmikailstaples changed the title doc: LSDV-5358: Add Generative AI templates docs: LSDV-5358: Add Generative AI templates Jul 12, 2023
@erinmikailstaples erinmikailstaples merged commit 4390f7e into develop Jul 13, 2023
27 checks passed
shayantabatabaee pushed a commit to shayantabatabaee/label-studio that referenced this pull request Sep 19, 2023
* Add Generative AI templates

* Build GenAI menu section

* docs: update generative ai templates

* docs: update spacing on generative visual ranker

* Turn off line breaks in markdown files

* docs update:add context behind gen ai templates

* Improve header formatting

* Fix config in templates

* Fix link typo

* Add more links

* Fix ranker template

* Fix visual ranker template

* Add desc

* typos — spelling errors corrected

---------

Co-authored-by: nik <nik@heartex.net>
Co-authored-by: Erin Mikail Staples <54031531+erinmikailstaples@users.noreply.github.com>
Co-authored-by: Hugues Tennier <huguestennier@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants