Skip to content
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

Continue improving docstrings #734

Merged
merged 1 commit into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/api_reference/components/classifier.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/api_reference/components/function.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/api_reference/components/model.md

This file was deleted.

7 changes: 7 additions & 0 deletions docs/api_reference/core/_v1_compat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# V1 compatibility
::: marvin.core._v1_compat
options:
members:
- ai_fn
- ai_model
- ai_classifier
15 changes: 1 addition & 14 deletions docs/api_reference/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1 @@
# Sections

## Components
- [Classifier](/api_reference/components/classifier/)
- [Function](/api_reference/components/function/)
- [Model](/api_reference/components/model/)
- [Prompt Function](/api_reference/components/prompt_fn/)
- [Text](/api_reference/components/text/)
## Settings
- [Settings](/api_reference/settings/)

## Utilities
- [`jinja`](/api_reference/utilities/jinja/)
- [`logging`](/api_reference/utilities/logging/)
# The Marvin API Reference
1 change: 1 addition & 0 deletions docs/api_reference/requests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: marvin.requests
2 changes: 1 addition & 1 deletion docs/welcome/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ free to use, rigorously type-hinted, used by thousands of engineers, and built b
Marvin is lightweight and is built for incremental adoption. You can use it purely as a serialization library and bring your own stack,
or fully use its engine to work with OpenAI and other providers.

??? Example "What Marvin feels like."
??? Example "How Marvin feels"

=== "Structured Data Extraction"
Marvin exposes a number of high level components to simplify working with AI.
Expand Down
22 changes: 13 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ nav:
- welcome/installation.md
- welcome/quickstart.md
- help/legacy_docs.md
- Cookbook:
- Entity deduplication: examples/deduplication.md
- Deploying an API:
- Basic extraction API: examples/extraction_api.md
- Basic classification API: examples/classification_api.md
- Docs:
- Overview: welcome/overview.md

Expand Down Expand Up @@ -43,16 +38,25 @@ nav:
# - GitHub Digest: examples/github_digest.md
- API reference:
- api_reference/index.md
- Core tools:
- Text & Data: api_reference/core/text.md
- Core AI features:
- Text & data: api_reference/core/text.md
- Images: api_reference/core/images.md
- Audio: api_reference/core/audio.md

- V1 compatibility: api_reference/core/_v1_compat.md
- Object schemas:
- Object schemas: api_reference/requests.md
- Settings:
- settings: api_reference/settings.md
- Settings: api_reference/settings.md
- Utilities:
- asyncio: api_reference/utilities/asyncio.md
- jinja: api_reference/utilities/jinja.md
- logging: api_reference/utilities/logging.md
- tools: api_reference/utilities/tools.md
- Cookbook:
- Entity deduplication: examples/deduplication.md
- Deploying an API:
- Basic extraction API: examples/extraction_api.md
- Basic classification API: examples/classification_api.md
- Community:
- community/index.md
- Feedback 💙: community/feedback.md
Expand Down