-
Notifications
You must be signed in to change notification settings - Fork 378
add initial documentation for available integrations #2034
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
Open
davanstrien
wants to merge
31
commits into
main
Choose a base branch
from
ip-open-code-intergration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 9 commits
Commits
Show all changes
31 commits
Select commit
Hold shift + click to select a range
c2645e7
feat/integrations: add initial documentation for available integrations
davanstrien 91e4a4f
feat(open-code): add initial documentation for OpenCode integration w…
davanstrien fbcc4cf
fix(open-code): clarify GitHub Actions integration usage in documenta…
davanstrien e89f905
feat(integrations): add Inference Provider Integrations section to do…
davanstrien 794cece
feat(integrations): add OpenCode section to Inference Provider Integr…
davanstrien 55ce637
fix(integrations): correct spelling and formatting in Integrations se…
davanstrien ed4587f
try different organization
davanstrien 21e1e21
temp example intergration page
davanstrien 1113a5d
fix(integrations): update OpenCode logo URLs to use absolute paths
davanstrien 7c14a24
feat(integrations): add MacWhisper integration documentation
davanstrien 7175c29
fix(integrations): comment out OpenCode logo HTML for clarity
davanstrien c7afa96
refactor(integrations): enhance overview and structure of integration…
davanstrien 5c86e6f
typo
davanstrien 1d96831
feat(integrations): add initial integrations overview documentation
davanstrien 65a509a
simple index version
davanstrien 44513d4
feat(integrations): add simple version of integrations overview
davanstrien 9c79d19
feat(integrations): update integrations section and remove outdated d…
davanstrien 45caf3d
tidy poc
davanstrien 0af6158
first pass
davanstrien 569c6c2
second pass
davanstrien 76dcade
feat(integrations): implement hybrid table + categories structure
davanstrien 79dbac3
fix(macwhisper): update prerequisites and model ID examples for clarity
davanstrien de18917
fix(adding-integration): simplify requirements and submission steps f…
davanstrien 109fa93
fix(adding-integration): update code block formatting for consistency
davanstrien 13c0c8a
fix(adding-integration): correct terminology for Inference Providers
davanstrien c44e8c9
fix(adding-integration): remove emphasis formatting from submission s…
davanstrien 59d6270
fix(adding-integration): remove unnecessary questions section for cla…
davanstrien b6075ea
fix(adding-integration): add clarification on compatibility with Open…
davanstrien e3f5c89
fix(adding-integration): update documentation to clarify connection t…
davanstrien e23f893
simpler
davanstrien c6dbff4
Update docs/inference-providers/integrations/index.md
davanstrien File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
59 changes: 59 additions & 0 deletions
59
docs/inference-providers/intergrations/adding-integration.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # Add Your Integration | ||
|
|
||
| Building a tool that works with Hugging Face Inference Providers? We'd love to feature it in our integrations directory! | ||
|
|
||
| ## Requirements | ||
|
|
||
| To be listed, your integration should: | ||
|
|
||
| - ✅ **Work with HF Inference Providers** via our API or OpenAI-compatible endpoints | ||
| - ✅ **Be actively maintained** with recent commits or releases | ||
| - ✅ **Have clear documentation** showing how to connect to HF | ||
|
|
||
| ## How to Submit | ||
|
|
||
| 1. **Test your integration** with Hugging Face Inference Providers | ||
| 2. **Fork the repository** at [github.com/huggingface/hub-docs](https://github.com/huggingface/hub-docs) | ||
| 3. **Add your integration page** in `docs/inference-providers/integrations/` | ||
| 4. **Update the index** in `docs/inference-providers/integrations/index.md` | ||
| 5. **Submit a Pull Request** with your changes | ||
|
|
||
| ## Integration Page Template | ||
|
|
||
| Create a file named `your-tool-name.md` with this structure: | ||
|
|
||
| ```markdown | ||
| # Your Tool Name | ||
|
|
||
| Brief description of what your tool does. | ||
|
|
||
| ## Overview | ||
|
|
||
| How your tool integrates with Hugging Face Inference Providers. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Your tool installed | ||
| - HF account with [API token](https://huggingface.co/settings/tokens) | ||
|
|
||
| ## Configuration | ||
|
|
||
| Step-by-step setup instructions with code examples. | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Your Tool Documentation](https://yourtool.com/docs) | ||
| - [HF Integration Guide](link-to-your-guide) | ||
| ``` | ||
|
|
||
| ## Updating the Index | ||
|
|
||
| Add your tool to the table in `integrations/index.md`: | ||
|
|
||
| ```markdown | ||
| | [Your Tool](./your-tool) | Brief description | [Docs](https://yourtool.com/docs) | [Guide](../guides/your-guide) | | ||
| ``` | ||
|
|
||
| ## Questions? | ||
|
|
||
| Need help with your integration? Visit the [Hugging Face Forums](https://discuss.huggingface.co/) or open an issue in the [hub-docs repository](https://github.com/huggingface/hub-docs/issues). |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Integrations | ||
|
|
||
| Hugging Face Inference Providers integrates with a growing ecosystem of tools making it easy to use state-of-the-art models in your favorite development environments and workflows. | ||
|
|
||
| ## Available Integrations | ||
|
|
||
| | Integration | Description | Tool Documentation | HF Guide | | ||
| | ----------------------- | -------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------------------- | | ||
| | [OpenCode](./open-code) | AI coding agent built for the terminal | [Docs](https://opencode.ai/docs/providers/#hugging-face) | [GitHub Actions with OpenCode](../guides/github-actions-code-review) | | ||
|
|
||
| ## Adding Your Integration | ||
|
|
||
| Building a tool that integrates with Hugging Face Inference Providers? We'd love to feature it! Check our [contribution guidelines](https://github.com/huggingface/hub-docs) for details on how to add your integration to this page. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # OpenCode | ||
|
|
||
| <div class="flex justify-center"> | ||
| <a href="https://opencode.ai/" target="_blank"> | ||
| <img class="block dark:hidden" src="https://opencode.ai/_build/assets/preview-opencode-wordmark-light-nzmKQT2r.png" alt="OpenCode"> | ||
| <img class="hidden dark:block" src="https://opencode.ai/_build/assets/preview-opencode-wordmark-dark-tZ1Y3VXe.png" alt="OpenCode"/> | ||
| </a> | ||
| </div> | ||
|
|
||
| [OpenCode](https://opencode.ai/) is an AI coding agent built for the terminal that helps with code review, refactoring, testing, and general development tasks. | ||
|
|
||
| ## Overview | ||
|
|
||
| OpenCode natively supports Hugging Face Inference Providers, giving you access to open models from 17+ providers through a single interface. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - OpenCode installed ([installation guide](https://opencode.ai/docs)) | ||
| - A Hugging Face account with [API token](https://huggingface.co/settings/tokens/new?ownUserPermissions=inference.serverless.write&tokenType=fineGrained) (needs "Make calls to Inference Providers" permission) | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Quick Setup | ||
|
|
||
| 1. Create a Hugging Face token with Inference Providers permissions at [huggingface.co/settings/tokens](https://huggingface.co/settings/tokens/new?ownUserPermissions=inference.serverless.write&tokenType=fineGrained) | ||
|
|
||
| 2. Run `opencode auth login` and select **Hugging Face**: | ||
|
|
||
| ```bash | ||
| $ opencode auth login | ||
|
|
||
| ┌ Add credential | ||
| │ | ||
| ◆ Select provider | ||
| │ ● Hugging Face | ||
| │ ... | ||
| └ | ||
| ``` | ||
|
|
||
| 3. Enter your Hugging Face token when prompted: | ||
|
|
||
| ```bash | ||
| ┌ Add credential | ||
| │ | ||
| ◇ Select provider | ||
| │ Hugging Face | ||
| │ | ||
| ◇ Enter your API key | ||
| │ hf_... | ||
| └ | ||
| ``` | ||
|
|
||
| 4. Run the `/models` command in OpenCode to select a model. | ||
|
|
||
| Once configured, OpenCode will use your selected model for all operations. You can switch models anytime using the `/models` command in the OpenCode TUI (Terminal User Interface). | ||
|
|
||
| ## GitHub Actions Integration | ||
|
|
||
| OpenCode can also be used to run open models in GitHub Actions via Inference Providers. See our [GitHub Actions guide](../guides/github-actions-code-review) for setting up automated PR reviews. | ||
|
|
||
| ## Resources | ||
|
|
||
| - [OpenCode Documentation](https://opencode.ai/docs) | ||
| - [OpenCode Provider Configuration](https://opencode.ai/docs/providers/#hugging-face) | ||
| - [GitHub Actions Integration Guide](../guides/github-actions-code-review) |
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.
Uh oh!
There was an error while loading. Please reload this page.