Move Client Documentation to /integrations/ #1190
Closed
Conversation
This file contains 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
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
- Move all client docs from /hub/clients/ to /integrations/ - Update mkdocs.yml navigation structure - Add test files for client examples - Document streaming limitations - Add .env.tests for missing API keys - Clean up old client documentation files Link to Devin run: https://preview.devin.ai/devin/89a9e436607c4cbea0bf1a301d3168a5
- Add llama wrapper for testing - Add setup.py for test dependencies - Improve error handling in Fireworks client
Deploying instructor-py with
|
| Latest commit: |
e6d4921
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0caa854f.instructor-py.pages.dev |
| Branch Preview URL: | https://docs-move-to-integrations.instructor-py.pages.dev |
github-actions
bot
added
documentation
- Remove unused imports - Update type annotations to modern syntax - Replace assert False with raise AssertionError - Use _ for unused loop variables
jxnl
reviewed
Nov 17, 2024
streaming_support.md
Outdated
| @@ -0,0 +1,12 @@ | |||
| # Client Streaming Support Matrix | |||
test_results.md
Outdated
| @@ -0,0 +1,42 @@ | |||
| # Instructor Integration Test Results | |||
test_clients/anthropic_test.py
Outdated
| @@ -0,0 +1,66 @@ | |||
| import os | |||
There was a problem hiding this comment.
dont include any of the test_clients files
- Remove test_clients directory as requested - Remove test_results.md and streaming_support.md - Focus PR on documentation changes only
- Remove llama_wrapper.py (test infrastructure) - Remove setup.py (test dependencies) - Remove .env.tests - Restore client_fireworks.py to main version - Keep only documentation changes
jxnl
requested changes
Nov 17, 2024
mkdocs.yml
Outdated
| @@ -209,6 +201,21 @@ nav: | |||
| - Generating Knowledge Graphs with Structured Outputs: 'hub/knowledge_graph.md' | |||
| - Extracting Relevant Clips from YouTube Videos: "hub/youtube_clips.md" | |||
| - Building Knowledge Graphs with Structured Outputs: 'tutorials/5-knowledge-graphs.ipynb' | |||
| - Integrations: | |||
| - Structured outputs with Anyscale: 'integrations/anyscale.md' | |||
There was a problem hiding this comment.
just make this "Anthropic" and remove the structured output refereces
set the title in the md file
| - Structured Outputs with Anyscale: 'hub/anyscale.md' | ||
| - Structured Outputs with Groq: 'hub/groq.md' | ||
| - Structured Outputs with Mistral: 'hub/mistral.md' | ||
| - Structured Outputs with Cohere: 'hub/cohere.md' |
There was a problem hiding this comment.
create a redirect map for the deleted stuff, using the mkdocs redirect map features
|
|
||
| ## Updates and Compatibility | ||
|
|
||
| Instructor maintains compatibility with Vertex AI's latest API versions. Check the [changelog](../../CHANGELOG.md) for updates. |
There was a problem hiding this comment.
remove all references to change log
docs/integrations/openai.md
Outdated
| - Document Analysis | ||
| - Configuration Generation | ||
|
|
||
| ## Troubleshooting |
There was a problem hiding this comment.
remove all trouble shotting examples in all docs
…itles and add redirect maps - Remove troubleshooting sections from all integration docs - Remove 'Structured outputs with' prefix from navigation titles - Add redirect maps for moved documentation pages - Clean up documentation structure
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.
Move Client Documentation to /integrations/
This PR moves all client documentation from /hub/clients/ to /integrations/ and implements comprehensive documentation updates.
Changes
Documentation Updates
Streaming Support Documentation
Testing
Link to Devin run: https://preview.devin.ai/devin/89a9e436607c4cbea0bf1a301d3168a5
If you have any feedback, you can leave comments in the PR and I'll address them in the app!