Skip to content

Conversation

demjened
Copy link
Contributor

@demjened demjened commented May 4, 2023

Fix ELSER download instructions (via Enterprise Search) in ml-nlp-elser.asciidoc.

The end-to-end process requires two user actions:

  • Download the model with "Deploy" button
  • Start the model after it's been downloaded

Fix ELSER download instructions (via Enterprise Search) in `ml-nlp-elser.asciidoc`.
@github-actions
Copy link

github-actions bot commented May 4, 2023

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
Copy link
Contributor

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ack. Will do today.

Copy link
Contributor

@szabosteve szabosteve May 5, 2023

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?

Copy link
Contributor Author

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.

Copy link
Contributor

@droberts195 droberts195 left a comment

Choose a reason for hiding this comment

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

LGTM

@mergify
Copy link
Contributor

mergify bot commented May 5, 2023

⚠️ The sha of the head commit of this PR conflicts with #2392. Mergify cannot evaluate rules on this PR. ⚠️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants