Documents the model memory estimation in the edit job flyout#6592
Open
nastasha-solomon wants to merge 4 commits into
Open
Documents the model memory estimation in the edit job flyout#6592nastasha-solomon wants to merge 4 commits into
nastasha-solomon wants to merge 4 commits into
Conversation
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
Vale Linting ResultsSummary: 1 suggestion found 💡 Suggestions (1)
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
Contributor
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Changes are generally clear and well-written. Found one minor grammar issue and one instance of redundant wording. The Vale linting comment already flagged appropriate word-choice issues.
- Jargon: No Elastic-internal jargon issues found. UI labels and technical terms are appropriately used in context.
- Frontmatter and applies_to: All four files have proper frontmatter with required
products,applies_to, andmapped_pagesfields. The newapplies_totags for 9.5+ features follow the correct cumulative docs pattern. - Content type fit: Changes maintain appropriate structure for each page type (scale guides, how-to, and limitations reference).
- Parent issue satisfaction: Satisfied. The PR successfully documents the Apply estimation option in the edit job flyout for both anomaly detection and data frame analytics jobs as requested in issue #6495.
Nits
- Line 113 of
ml-ad-run-jobs.mduses "hit" where style guide prefers "reach" or "exceed" (already flagged by Vale). - Line 86 of
anomaly-detection-scale.md: "However, you must provide your own cardinality estimates when using the API" could flow better as "However, when using the API, you must provide your own cardinality estimates."
Generated by Docs review agent for issue #6592 · ● 781K
|
|
||
| If a job fails to start because it requires more memory than the configured limit, stop the job and increase `model_memory_limit` using the [update {{dfanalytics-jobs}} API]({{es-apis}}operation/operation-ml-update-data-frame-analytics) or, {applies_to}`stack: ga 9.5`{applies_to}`serverless: ga` select **Apply** under the **Model memory limit** field in the edit job flyout. For more guidance, refer to [Working with {{dfanalytics}} at scale](ml-dfa-scale.md#set-model-memory-limit). | ||
|
|
||
| When you create a {{dfanalytics-job}} and the inference step of the process fails due to the model is too large to fit into JVM, follow the steps in [this GitHub issue](https://github.com/elastic/elasticsearch/issues/76093) for a workaround. |
Contributor
There was a problem hiding this comment.
Grammar issue with "due to the model is" construction. Use "due to" with a noun phrase or gerund:
Suggested change
| When you create a {{dfanalytics-job}} and the inference step of the process fails due to the model is too large to fit into JVM, follow the steps in [this GitHub issue](https://github.com/elastic/elasticsearch/issues/76093) for a workaround. | |
| When you create a {{dfanalytics-job}} and the inference step of the process fails due to the model being too large to fit into JVM, follow the steps in [this GitHub issue](https://github.com/elastic/elasticsearch/issues/76093) for a workaround. |
| You cannot update {{dfanalytics}} configurations. Instead, delete the {{dfanalytics-job}} and create a new one. | ||
| You cannot update most {{dfanalytics}} configuration settings after job creation (such as the analysis type, dependent variable, or source index). To change those settings, delete the {{dfanalytics-job}} and create a new one. | ||
|
|
||
| You can update `model_memory_limit` on a stopped job using the [update {{dfanalytics-jobs}} API]({{es-apis}}operation/operation-ml-update-data-frame-analytics). {applies_to}`stack: ga 9.5`{applies_to}`serverless: ga` In {{kib}}, navigate to the **Data Frame Analytics** page, open the edit flyout for the stopped job, and select **Apply** under the **Model memory limit** field in the edit job flyout. |
Contributor
There was a problem hiding this comment.
The phrase "in the edit job flyout" appears twice in this sentence, making it redundant. Consider simplifying:
Suggested change
| You can update `model_memory_limit` on a stopped job using the [update {{dfanalytics-jobs}} API]({{es-apis}}operation/operation-ml-update-data-frame-analytics). {applies_to}`stack: ga 9.5`{applies_to}`serverless: ga` In {{kib}}, navigate to the **Data Frame Analytics** page, open the edit flyout for the stopped job, and select **Apply** under the **Model memory limit** field in the edit job flyout. | |
| You can update `model_memory_limit` on a stopped job using the [update {{dfanalytics-jobs}} API]({{es-apis}}operation/operation-ml-update-data-frame-analytics). {applies_to}`stack: ga 9.5`{applies_to}`serverless: ga` In {{kib}}, navigate to the **Data Frame Analytics** page, open the edit flyout for the stopped job, and select **Apply** under the **Model memory limit** field. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the Apply estimation option in the Kibana edit job flyout for anomaly detection and data frame analytics jobs to fix #6495.
Previews
Working with anomaly detection at scale | Set the model memory limit - Updated guidance on adjusting
model_memory_limitfor existing jobs to mention the Apply option in the edit job flyout on the Anomaly Detection Jobs page. Updated the tip to lead with the UI option before the API fallback.Run a job | Model memory limits - Added a paragraph surfacing Apply in the edit job flyout. This is the primary landing page for users hitting memory issues, so it's the right place to mention the shortcut before they resort to recreating the job.
Data frame analytics limitations - Made two changes:
model_memory_limitcan using the API or Apply in the edit job flyout on the Data Frame Analytics page.Working with data frame analytics at scale | 7. Set the model memory limit - New section explaining what
model_memory_limitcontrols, how to update it via the API or Apply in the edit job flyout, and how to get a memory estimate. Modeled after the equivalent section on the anomaly detection at scale page.Generative AI disclosure