Skip to content

Conversation

alexmojaki
Copy link
Contributor

and other related refinements to docs.

Also renames InstrumentedModel.options to settings to match the type name.

Closes #1070

Copy link
Contributor

hyperlint-ai bot commented Mar 20, 2025

PR Change Summary

Documented the InstrumentedModel and made related refinements to the documentation, including renaming InstrumentedModel.options to settings.

  • Added documentation for InstrumentedModel and wrapper models.
  • Renamed InstrumentedModel.options to settings for consistency.
  • Updated references to InstrumentationSettings in the logfire documentation.

Modified Files

  • docs/logfire.md

Added Files

  • docs/api/models/instrumented.md
  • docs/api/models/wrapper.md

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

Copy link

github-actions bot commented Mar 20, 2025

Docs Preview

commit: f7627e5
Preview URL: https://8ae16753-pydantic-ai-previews.pydantic.workers.dev

@alexmojaki alexmojaki merged commit fd90fc6 into main Mar 20, 2025
17 checks passed
@alexmojaki alexmojaki deleted the alex/doc-ins-model branch March 20, 2025 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on Instrumentation?
2 participants