Skip to content

Add inference doc code examples #2488

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

Merged
merged 2 commits into from
Mar 26, 2024
Merged

Conversation

iuliaferoli
Copy link
Contributor

I'm adding inference doc code examples per #2429

Copy link

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.

@pquentin
Copy link
Member

Thanks Iulia! Note that simply adding the pages is not enough, you also have to run python utils/generate-examples.py after having cloned the client-flights-recorder repository. And then check that the results make sense. I'm happy to assist more.

@iuliaferoli
Copy link
Contributor Author

Hey Quentin!
I've generated the examples and fixed a few minor details.
For example, it generated inference_id instead of model_id; so I think this also needs to be changed in the docs here: https://elasticsearch-py.readthedocs.io/en/latest/api/inference.html

Also I've had some trouble with the branches so it looks quite messy - still trying to get rid of having the client changes in here as well instead of in the separate PR.

@iuliaferoli
Copy link
Contributor Author

iuliaferoli commented Mar 25, 2024

@pquentin I updated these examples with inference_id instead of model_id

@pquentin pquentin merged commit 135c60a into elastic:main Mar 26, 2024
github-actions bot pushed a commit that referenced this pull request Mar 26, 2024
* Add inference examples

* switching from `model_id` to `inference_id`
 as per discussion.

(cherry picked from commit 135c60a)
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.

2 participants