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

Makes inference endpoint the primary way to download and deploy ELSER and E5 #2765

Merged
merged 5 commits into from
Aug 2, 2024

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Aug 1, 2024

Overview

This PR overhauls the ELSER and E5 conceptual pages:

  • indicates that the recommended and easiest way to download and deploy the models is using inference endpoints,
  • introduces the procedure of creating an inference endpoint in the Download and deploy section,
  • makes the alternative download and deploy methods less prominent by putting them into collapsible sections that are closed by default,
  • propagates the semantic_text workflow for semantic search.

Preview

Copy link

github-actions bot commented Aug 1, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@szabosteve szabosteve marked this pull request as ready for review August 1, 2024 16:00
@szabosteve szabosteve requested a review from a team as a code owner August 1, 2024 16:00
Copy link
Member

@maxhniebergall maxhniebergall left a comment

Choose a reason for hiding this comment

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

This looks good, but I just want to double check with Jan that adaptive allocations made it into the 8.15 release before I approve this.

docs/en/stack/ml/nlp/ml-nlp-e5.asciidoc Outdated Show resolved Hide resolved
@szabosteve
Copy link
Contributor Author

szabosteve commented Aug 2, 2024

@maxhniebergall Thanks for the review! I just merged the adaptive allocations-related documentation yesterday. Jan asked me to draft the docs and he approved the PRs. You can find these here:

However, I can change the API requests in this PR to NOT use adaptive_allocations if you prefer.

@szabosteve
Copy link
Contributor Author

szabosteve commented Aug 2, 2024

@maxhniebergall I replaced the adaptive_allocations settings with num_allocations and num_threads via e11530e

Copy link
Member

@maxhniebergall maxhniebergall left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks for the quick fixes. We will definitely want to re-add the adaptive allocations in 8.16.

@szabosteve szabosteve merged commit 071c0fe into elastic:main Aug 2, 2024
3 checks passed
@szabosteve szabosteve deleted the elser-e5-overhaul branch August 2, 2024 14:07
mergify bot pushed a commit that referenced this pull request Aug 2, 2024
… and E5 (#2765)

* Adds inference API steps.

* Makes inference endpoint the primary way to download and deploy ELSER and E5.

* Fixes block.

* Fixes typo.

* [DOCS] Replaces adaptive allocations settings.

(cherry picked from commit 071c0fe)
szabosteve added a commit that referenced this pull request Aug 2, 2024
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