-
Notifications
You must be signed in to change notification settings - Fork 255
Fix ELSER download instructions #2391
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
Conversation
Fix ELSER download instructions (via Enterprise Search) in `ml-nlp-elser.asciidoc`.
Documentation preview: |
"Fine-tune performance" option to navigate to the **Trained Models** page where | ||
you can configure the model deployment. | ||
|
||
4. Under **{ml-app} {infer-cap} Pipelines**, click "Deploy" button to begin downloading |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since there are two steps for Enterprise Search as well as the other methods it probably makes sense to structure this whole docs page similarly for all 3 methods.
At the moment we have high level "Download" and "Deploy" sections with the two steps split for the ML UI and dev console but Enterprise Search's two steps all in the first section. So it's probably better to either just have one high level section and put all the steps for each method in one list for that method. Or else split Enterprise Search too.
This also highlights that there is different terminology in different apps. ML is using "deploy" to mean "start" whereas Enterprise Search is using "deploy" to mean "download".
@szabosteve maybe you should take over this PR to do a broader refactoring.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ack. Will do today.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@droberts195
I merged the "Download" and "Deploy" sections in 92ec67f, so the structure of the docs is consistent for all the three scenarios. I think it's a better solution than separating the three scenarios into two sections because the docs navigation will be a bit simpler (== more user-friendly) this way.
Is it possible to harmonize the use of terminology between the Trained Models UI and the Enterprise Search UI regarding downloading/deploying/starting ELSER?
@demjened I apologize for pushing content to your PR without prior discussion, I hope you don't mind. I didn't change anything in your content. I see that the PR targets 8.8
. Could you please forward-port the changes to main
when the PR is merged?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @szabosteve, it's all good 🙂 Yep, I'll forward-port.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
Fix ELSER download instructions (via Enterprise Search) in
ml-nlp-elser.asciidoc
.The end-to-end process requires two user actions: