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.

Sign up for GitHub

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

Jump to bottom

Adds E5 model docs #2601

Merged
merged 12 commits into from
Dec 7, 2023
Merged

Adds E5 model docs #2601

merged 12 commits into from
Dec 7, 2023

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Nov 30, 2023 •
edited
Loading

Overview

This PR:

  • adds conceptual docs and installation instructions for E5,
  • adds link to air-gapped install instructions,
  • adds E5 limitation item,
  • creates a Built-in models section in the NLP book,
  • moves ELSER, E5, and the language identification model under the Built-in models section,
  • links to the model cards on HuggingFace due to legal stuff.

Previews

@github-actions GitHub Actions
Copy link

Documentation preview:

@szabosteve szabosteve changed the title E5 model docs Adds E5 model docs Nov 30, 2023
@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 30, 2023

This pull request does not have a backport label. Could you fix it @szabosteve? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip automated backport with mergify label Nov 30, 2023
@szabosteve
Copy link
Contributor Author

@elasticmachine test this please

@szabosteve szabosteve marked this pull request as ready for review December 7, 2023 09:09
@szabosteve szabosteve requested a review from a team as a code owner December 7, 2023 09:09
davidkyle
davidkyle approved these changes Dec 7, 2023
View reviewed changes
Copy link
Member

@davidkyle davidkyle left a comment

Choose a reason for hiding this comment

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

One comment otherwise LGTM

docs/en/stack/ml/nlp/ml-nlp-e5.asciidoc Show resolved Hide resolved
@szabosteve szabosteve added v8.13 backport-8.12 Automated backport with mergify and removed backport-skip Skip automated backport with mergify labels Dec 7, 2023
@szabosteve szabosteve removed the WIP Work in progress label Dec 7, 2023
@szabosteve szabosteve merged commit 52b75c5 into elastic:main Dec 7, 2023
1 check passed
@szabosteve szabosteve deleted the e5-model-docs branch December 7, 2023 10:18
mergify bot pushed a commit that referenced this pull request Dec 7, 2023
@szabosteve @mergify
Adds E5 model docs (#2601)
de16db6 
* Restructures NLP chapter and adds initial docs for E5.

* [DOCS] HIghlights text.

* [DOCS] Documents limitation.

* [DOCS] Adds install instructions.

* Fixes section IDs.

* [DOCS] Fixes link.

* Adds screenshots, provides install steps for trained model UI.

* Adds search indices UI and dev consol install methods.

* Links to HuggingFace model cards.

* Adds air-gapped install link.

* Removes tech preview badge.

* Addresses feedback.

(cherry picked from commit 52b75c5)
@mergify mergify bot mentioned this pull request Dec 7, 2023
Merged
szabosteve added a commit that referenced this pull request Dec 7, 2023
@mergify @szabosteve
Adds E5 model docs (#2601) (#2607)
c9832ef 
Co-authored-by: István Zoltán Szabó <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davidkyle davidkyle davidkyle approved these changes

@dimkots dimkots Awaiting requested review from dimkots

Assignees
No one assigned
Labels
backport-8.12 Automated backport with mergify :ml nlp v8.12 v8.13
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@szabosteve @davidkyle