[ML] ELSER v2 download in the Trained Models UI #167407

darnautov · 2023-09-27T13:24:57Z

Summary

Adds support for ELSER v2 download from the Trained Models UI.

Marks an appropriate model version for the current cluster configuration with the recommended flag.
Updates the state column with better human-readable labels and colour indicators.
Adds a callout promoting a new version of ELSER

Notes for reviews

We need to wait for Platform specific models elasticsearch#99584 to get the start deployment validation functionality. At the moment you can successfully start deployment of the wrong model version.

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

elasticmachine · 2023-09-27T13:25:01Z

Pinging @elastic/ml-ui (:ml)

peteharverson · 2023-09-27T16:23:23Z

As discussed separately, we need to think of a better way of directing the user to which of the two ELSER models is recommended for their architecture. With the current use of a badge, it can appear like we're recommending of all the users' third party, models from DFA jobs, and ELSER models, that this one is especially recommended.

I think simply adding an extra sentence to the end of the model description would be an improvement over the badge.

Any thoughts on a better UX here @mdefazio ?

mdefazio · 2023-09-27T17:21:02Z

@peteharverson

Went back and forth on this as well, and agree there's some oddities for this iteration. The accent badge feels too close to an error and draws too much attention in my opinion.

I had played around with other placements of the badge (as we discussed in Slack), but agree that simple text might be preferable here.

Here's an option appending Recommended to the description. The one small effect of this that I would recommend is moving the 'Tech preview' badge to the id column to give us some more room. Not a deal breaker, but something to consider.

cc/ @julianrosado in case you have some thoughts here too.

I'm also dropping in an option showing a badge next to the download button. Not sure how much complexity this brings to the implementation (with conditional column rendering), but provides a clear landmark near the download action.

x-pack/plugins/ml/public/application/model_management/models_list.tsx

mdefazio · 2023-09-29T11:55:32Z

@darnautov @peteharverson I've gone back and forth on the additional badge for 'recommended'. Here are two options and I'll leave it to you for what's possible at this stage.

Note the additional banner. This should show if v1 is already downloaded. If not, then shouldn't need this and they would only see v2 anyway.
(No icon necessary, but note the option to dismiss)

EuiCallout size='s' color='primary' onDismiss =(...)
Title: New ELSER model now available
Content: ELSER model v2 release shows faster performance and better relevance for improved information retrieval . <View documentation>
Link should go to the ELSER documentation

Alternative version using the badge next to the download button for extra affordance

mdefazio · 2023-09-29T11:56:16Z

Link should go to the...

@peteharverson might have a more accurate link

peteharverson · 2023-09-29T12:15:46Z

I confirmed with @szabosteve that the link should go to the existing docs page, which will be updated for ELSER v2.

darnautov · 2023-09-29T14:20:42Z

Many thanks for the mockups @mdefazio, ELSER callout has been added in 106ce06

szabosteve

UI text and doc URL LGTM!

leemthompo · 2023-09-29T14:28:53Z

x-pack/plugins/ml/public/application/model_management/models_list.tsx

+                >
+                  <FormattedMessage
+                    id="xpack.ml.trainedModels.modelsList.newElserModelDescription"
+                    defaultMessage="ELSER model v2 release shows faster performance and better relevance for improved information retrieval."


Suggested change

defaultMessage="ELSER model v2 release shows faster performance and better relevance for improved information retrieval."

defaultMessage="The ELSER v2 model has improved speed and relevance, delivering faster, more performant information retrieval."

Totally optional rewording suggestion :)

Do we want to substitue "information retrieval" for "text expansion" or "semantic search"?

Reviewed the text for the callout with @arisonl and will go with A new version of ELSER that shows faster performance and improved relevance is now available. View documentation for information on how to start using it.

x-pack/plugins/ml/public/application/model_management/models_list.tsx

darnautov · 2023-10-02T10:13:28Z

@elasticmachine merge upstream

x-pack/plugins/ml/public/application/model_management/model_actions.tsx

jgowdyelastic · 2023-10-02T14:45:41Z

x-pack/plugins/ml/public/application/model_management/model_actions.tsx

        }),
        'data-test-subj': 'mlModelsTableRowDownloadModelAction',
+        // @ts-ignore


could be @ts-ignore be removed or have a reason added to it?

Added a comment in beef167

x-pack/plugins/ml/server/models/model_management/models_provider.ts

jgowdyelastic · 2023-10-02T15:12:56Z

x-pack/plugins/ml/public/application/model_management/models_list.tsx

@@ -95,17 +109,75 @@ interface Props {
  updatePageState?: (update: Partial<ListingPageUrlState>) => void;
 }

+export const getModelStateColor = (


This file is pretty big, could this function be moved to a utils file?

Refactored in beef167

x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts

…er-2-download

x-pack/plugins/ml/public/application/model_management/models_list.tsx

peteharverson

Tested (including on a deployment with a v1 model downloaded), and LGTM.

jgowdyelastic

LGTM

darnautov · 2023-10-03T08:13:28Z

@elasticmachine merge upstream

kibana-ci · 2023-10-03T09:19:50Z

💚 Build Succeeded

Buildkite Build
Commit: b535896

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`ml`	1816	1817	+1

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/ml-trained-models-utils`	22	29	+7

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`enterpriseSearch`	2.6MB	2.6MB	+64.0B
`lists`	147.1KB	147.1KB	+33.0B
`ml`	3.5MB	3.5MB	+3.2KB
total			+3.3KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	368.1KB	368.1KB	+33.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/ml-trained-models-utils`	22	29	+7

History

💔 Build #164612 failed 19c72b0
💔 Build #164595 failed beef167
💔 Build #164385 failed 43ea48f
💚 Build #164066 succeeded 4f5a274
💔 Build #164022 failed 106ce06

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @darnautov

darnautov added 6 commits September 26, 2023 16:57

hide elser v1 from download options, fetch list of downloads

28fbd5f

update state column

b3c4393

mark default as recommended if platform specific is not compatible

31126e3

update config

6210e58

show recommended badge

016838a

add tooltip

a7e8be2

darnautov added release_note:enhancement :ml Team:ML Team label for ML (also use :ml) v8.11.0 labels Sep 27, 2023

darnautov requested review from peteharverson, jgowdyelastic and szabosteve September 27, 2023 13:24

darnautov requested a review from a team as a code owner September 27, 2023 13:24

darnautov self-assigned this Sep 27, 2023

peteharverson mentioned this pull request Sep 27, 2023

[ML] Increase Test Coverage 8.11.0 #164562

Closed

10 tasks

label alignment

053b824

darnautov added 4 commits September 28, 2023 12:47

Merge remote-tracking branch 'origin/main' into ml-elser-2-download

0ce469b

move badges

490fde7

ID column

0a436df

text wrap

49d39b6

peteharverson reviewed Sep 29, 2023

View reviewed changes

x-pack/plugins/ml/public/application/model_management/models_list.tsx Outdated Show resolved Hide resolved

darnautov added 2 commits September 29, 2023 14:52

update tooltip content

efe9c0d

preserve recommended flag

83f4d59

darnautov requested a review from peteharverson September 29, 2023 14:19

szabosteve approved these changes Sep 29, 2023

View reviewed changes

leemthompo reviewed Sep 29, 2023

View reviewed changes

update i18n id

4f5a274

peteharverson reviewed Sep 29, 2023

View reviewed changes

x-pack/plugins/ml/public/application/model_management/models_list.tsx Show resolved Hide resolved

show callout only if elser v1 is installed

b478b9f

Merge branch 'main' into ml-elser-2-download

43ea48f

jgowdyelastic reviewed Oct 2, 2023

View reviewed changes

darnautov added 3 commits October 2, 2023 17:29

update tooltip content

0492e67

Merge remote-tracking branch 'origin/ml-elser-2-download' into ml-els…

a5c53e2

…er-2-download

refactor

beef167

darnautov requested review from peteharverson and jgowdyelastic October 2, 2023 15:49

peteharverson reviewed Oct 2, 2023

View reviewed changes

x-pack/plugins/ml/public/application/model_management/models_list.tsx Outdated Show resolved Hide resolved

darnautov added 2 commits October 2, 2023 18:19

add dot

6ef50c0

Merge remote-tracking branch 'origin/main' into ml-elser-2-download

19c72b0

darnautov requested a review from peteharverson October 2, 2023 16:23

peteharverson approved these changes Oct 2, 2023

View reviewed changes

jgowdyelastic approved these changes Oct 2, 2023

View reviewed changes

update functional tests

7a49165

Merge branch 'main' into ml-elser-2-download

b535896

darnautov enabled auto-merge (squash) October 3, 2023 08:13

darnautov merged commit 0c6dfbf into elastic:main Oct 3, 2023
19 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Oct 3, 2023

peteharverson added release_note:feature Makes this part of the condensed release notes and removed release_note:enhancement labels Oct 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] ELSER v2 download in the Trained Models UI #167407

[ML] ELSER v2 download in the Trained Models UI #167407

darnautov commented Sep 27, 2023 •

edited

elasticmachine commented Sep 27, 2023

peteharverson commented Sep 27, 2023

mdefazio commented Sep 27, 2023 •

edited

mdefazio commented Sep 29, 2023

mdefazio commented Sep 29, 2023

peteharverson commented Sep 29, 2023

darnautov commented Sep 29, 2023

szabosteve left a comment

leemthompo Sep 29, 2023 •

edited

leemthompo Sep 29, 2023

peteharverson Oct 2, 2023

darnautov commented Oct 2, 2023

jgowdyelastic Oct 2, 2023

darnautov Oct 2, 2023

jgowdyelastic Oct 2, 2023

darnautov Oct 2, 2023

peteharverson left a comment •

edited

jgowdyelastic left a comment

darnautov commented Oct 3, 2023

kibana-ci commented Oct 3, 2023

API count

	defaultMessage="ELSER model v2 release shows faster performance and better relevance for improved information retrieval."
	defaultMessage="The ELSER v2 model has improved speed and relevance, delivering faster, more performant information retrieval."

[ML] ELSER v2 download in the Trained Models UI #167407

[ML] ELSER v2 download in the Trained Models UI #167407

Conversation

darnautov commented Sep 27, 2023 • edited

Summary

Notes for reviews

Checklist

elasticmachine commented Sep 27, 2023

peteharverson commented Sep 27, 2023

mdefazio commented Sep 27, 2023 • edited

mdefazio commented Sep 29, 2023

mdefazio commented Sep 29, 2023

peteharverson commented Sep 29, 2023

darnautov commented Sep 29, 2023

szabosteve left a comment

Choose a reason for hiding this comment

leemthompo Sep 29, 2023 • edited

Choose a reason for hiding this comment

leemthompo Sep 29, 2023

Choose a reason for hiding this comment

peteharverson Oct 2, 2023

Choose a reason for hiding this comment

darnautov commented Oct 2, 2023

jgowdyelastic Oct 2, 2023

Choose a reason for hiding this comment

darnautov Oct 2, 2023

Choose a reason for hiding this comment

jgowdyelastic Oct 2, 2023

Choose a reason for hiding this comment

darnautov Oct 2, 2023

Choose a reason for hiding this comment

peteharverson left a comment • edited

Choose a reason for hiding this comment

jgowdyelastic left a comment

Choose a reason for hiding this comment

darnautov commented Oct 3, 2023

kibana-ci commented Oct 3, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

darnautov commented Sep 27, 2023 •

edited

mdefazio commented Sep 27, 2023 •

edited

leemthompo Sep 29, 2023 •

edited

peteharverson left a comment •

edited