Skip to content

[docs] add featherless docs #1748

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
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

DarinVerheijke
Copy link

@DarinVerheijke DarinVerheijke commented May 22, 2025

Adds Featherless.ai provider to the documentation:

Waiting on merge of huggingface/huggingface_hub#3081

@DarinVerheijke DarinVerheijke changed the title add featherless docs May 22, 2025
@DarinVerheijke DarinVerheijke marked this pull request as ready for review May 27, 2025 15:05
Copy link
Contributor

@hanouticelina hanouticelina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DarinVerheijke Thank you for this PR! could you open a PR in the huggingface/documentation-images repository to upload your logos (separate light and dark mode versions)? alternatively, you can provide the logos here and we will upload them :)

@DarinVerheijke
Copy link
Author

@DarinVerheijke Thank you for this PR! could you open a PR in the huggingface/documentation-images repository to upload your logos (separate light and dark mode versions)? alternatively, you can provide the logos here and we will upload them :)

ofcourse!
see: https://huggingface.co/datasets/huggingface/documentation-images/discussions/498

@hanouticelina
Copy link
Contributor

Hi @DarinVerheijke,
thank you, we're almost there! :) could you run pnpm install (if you haven’t already) and then pnpm run generate at the root of the scripts/inference-providers repository to generate the documentation for featherless AI ? after that, you just have to commit docs/inference-providers/providers/featherless-ai.md, docs/inference-providers/tasks/chat-completion.md and docs/inference-providers/tasks/text-generation.md.

@DarinVerheijke
Copy link
Author

DarinVerheijke commented Jun 3, 2025

Hi @DarinVerheijke, thank you, we're almost there! :) could you run pnpm install (if you haven’t already) and then pnpm run generate at the root of the scripts/inference-providers repository to generate the documentation for featherless AI ? after that, you just have to commit docs/inference-providers/providers/featherless-ai.md, docs/inference-providers/tasks/chat-completion.md and docs/inference-providers/tasks/text-generation.md.

I'm currently getting some errors with running the generate script, specifically in fetchwarmmodels(), is it possible that this is caused by us still being in staging?

@hanouticelina
Copy link
Contributor

I'm currently getting some errors with running the generate script, specifically in fetchwarmmodels(), is it possible that this is caused by us still being in staging

could you share the full traceback of the error?
I was able to run the script and generate the docs locally without issues, but I don t have write access to https://github.com/featherlessai/hub-docs/tree/featherless-docs, so I couldn't push the changes

@DarinVerheijke
Copy link
Author

DarinVerheijke commented Jun 3, 2025

I'm currently getting some errors with running the generate script, specifically in fetchwarmmodels(), is it possible that this is caused by us still being in staging

could you share the full traceback of the error? I was able to run the script and generate the docs locally without issues, but I don t have write access to https://github.com/featherlessai/hub-docs/tree/featherless-docs, so I couldn't push the changes

Strange, I'll try again, I've given you write access in the meanwhile,

EDIT to add traceback:

          providerModelId: providerData.providerId,
                                        ^
TypeError: Cannot read properties of undefined (reading 'providerId')

    at <anonymous> (/home/darin/hub-docs/scripts/inference-providers/scripts/generate.ts:546:41)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async Promise.all (index 0)
    at async fetchWarmModels (/home/darin/hub-docs/scripts/inference-providers/scripts/generate.ts:509:5)
    at async <anonymous> (/home/darin/hub-docs/scripts/inference-providers/scripts/generate.ts:558:40)
    at async Promise.all (index 13)
    at async <anonymous> (/home/darin/hub-docs/scripts/inference-providers/scripts/generate.ts:556:1)

Node.js v20.17.0
 ELIFECYCLE  Command failed with exit code 1.

@hanouticelina
Copy link
Contributor

hanouticelina commented Jun 3, 2025

I've given you write access in the meanwhile,

I still have only read permission to the repo and cannot push the changes

EDIT: nevermind, it works!

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Contributor

@hanouticelina hanouticelina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks a lot @DarinVerheijke for adding this! you can check the result here: https://moon-ci-docs.huggingface.co/docs/inference-providers/pr_1748/en/providers/featherless-ai

We will merge this as soon as we're ready to go live! cc @SBrandeis for viz

@DarinVerheijke
Copy link
Author

hanouticelina

Awesome thanks for taking the time!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants