From f85a6169ea596b9d465f9363db1da811ce43db2d Mon Sep 17 00:00:00 2001 From: Jeremiah Lowin <153965+jlowin@users.noreply.github.com> Date: Thu, 11 Jan 2024 16:58:05 -0500 Subject: [PATCH] Continue improving docstrings --- docs/api_reference/components/classifier.md | 1 - docs/api_reference/components/function.md | 1 - docs/api_reference/components/model.md | 1 - docs/api_reference/core/_v1_compat.md | 7 +++++++ docs/api_reference/index.md | 15 +------------- docs/api_reference/requests.md | 1 + docs/welcome/overview.md | 2 +- mkdocs.yml | 22 ++++++++++++--------- 8 files changed, 23 insertions(+), 27 deletions(-) delete mode 100644 docs/api_reference/components/classifier.md delete mode 100644 docs/api_reference/components/function.md delete mode 100644 docs/api_reference/components/model.md create mode 100644 docs/api_reference/core/_v1_compat.md create mode 100644 docs/api_reference/requests.md diff --git a/docs/api_reference/components/classifier.md b/docs/api_reference/components/classifier.md deleted file mode 100644 index 9d90d1ff8..000000000 --- a/docs/api_reference/components/classifier.md +++ /dev/null @@ -1 +0,0 @@ -::: marvin.core.text.classifier \ No newline at end of file diff --git a/docs/api_reference/components/function.md b/docs/api_reference/components/function.md deleted file mode 100644 index 6089e8507..000000000 --- a/docs/api_reference/components/function.md +++ /dev/null @@ -1 +0,0 @@ -::: marvin.core.text.fn \ No newline at end of file diff --git a/docs/api_reference/components/model.md b/docs/api_reference/components/model.md deleted file mode 100644 index 2d6b15c95..000000000 --- a/docs/api_reference/components/model.md +++ /dev/null @@ -1 +0,0 @@ -::: marvin.core.text.model \ No newline at end of file diff --git a/docs/api_reference/core/_v1_compat.md b/docs/api_reference/core/_v1_compat.md new file mode 100644 index 000000000..d3069d9ae --- /dev/null +++ b/docs/api_reference/core/_v1_compat.md @@ -0,0 +1,7 @@ +# V1 compatibility +::: marvin.core._v1_compat + options: + members: + - ai_fn + - ai_model + - ai_classifier \ No newline at end of file diff --git a/docs/api_reference/index.md b/docs/api_reference/index.md index d2ca1db1d..475a2b1f2 100644 --- a/docs/api_reference/index.md +++ b/docs/api_reference/index.md @@ -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 \ No newline at end of file diff --git a/docs/api_reference/requests.md b/docs/api_reference/requests.md new file mode 100644 index 000000000..962a508d5 --- /dev/null +++ b/docs/api_reference/requests.md @@ -0,0 +1 @@ +::: marvin.requests \ No newline at end of file diff --git a/docs/welcome/overview.md b/docs/welcome/overview.md index 74135886b..da060f2ef 100644 --- a/docs/welcome/overview.md +++ b/docs/welcome/overview.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index ed08ef482..062a98a1f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 @@ -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