Skip to content

[GUIDES] Improve inference providers documentation with guides - #1797

Merged
burtenshaw merged 16 commits into
mainfrom
improve-inference-providers-documentation
Jul 3, 2025
Merged

[GUIDES] Improve inference providers documentation with guides#1797
burtenshaw merged 16 commits into
mainfrom
improve-inference-providers-documentation

Conversation

@burtenshaw

Copy link
Copy Markdown
Collaborator

This PR is add's bite sized 'day 1' guides to the inference providers guides which should help first time users with the product:

  • first api call in 5 minutes
  • first app for transcription

It also includes two minor fixes:

  • add speech recognition to index table
  • expands the detail in the billing page

@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

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.

@julien-c julien-c left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

looks nice, i especially like the "Your First API Call" one

cc @Wauplin @hanouticelina too

Note, i think we should showcase more and more content in JS

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm could we split those into another PR?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yeah. Makes sense.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I opened this PR with just billing changes #1799

@burtenshaw

Copy link
Copy Markdown
Collaborator Author

Thanks for the review @julien-c

Note, i think we should showcase more and more content in JS

I could add a JS version of the transcription app too.

@Pierrci

Pierrci commented Jun 27, 2025

Copy link
Copy Markdown
Member

^yes!

@Vaibhavs10 Vaibhavs10 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice! very cool! love the simplicity of it, left some suggestions and more specifically a question about auto vs specific provider. Given this is tailored towards beginners or people who might not have as much insight about the ML/AI world - I tend to side with auto i.e. reduce the barrier to entry as much as possible.


When prompted, paste your Hugging Face token. This handles authentication automatically for all your inference calls. You can generate one from [your settings page](https://huggingface.co/settings/tokens/new?ownUserPermissions=inference.serverless.write&tokenType=fineGrained).

## Step 2: Build the User Interface

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

you can upload these as a colab notebook, so that people can just execute these as well.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Nice idea. I'll gunna come back to this and just re-use the new model repo notebooks.

Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md
Comment thread docs/inference-providers/guides/first-api-call.md Outdated
Comment thread docs/inference-providers/guides/first-api-call.md Outdated
Comment thread docs/inference-providers/guides/first-api-call.md Outdated
Comment thread docs/inference-providers/guides/first-api-call.md Outdated
@burtenshaw

Copy link
Copy Markdown
Collaborator Author

Thanks for the review @Vaibhavs10 . I've responded to all your comments and implemented a js version of the app.

@hanouticelina hanouticelina left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this is very cool, thanks for adding these guides @burtenshaw! I left some suggestions


const output = await client.automaticSpeechRecognition({
data: file,
model: "openai/whisper-large-v3-turbo",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

should be openai/whisper-large-v3, right?

Suggested change
model: "openai/whisper-large-v3-turbo",
model: "openai/whisper-large-v3",

Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
Comment thread docs/inference-providers/guides/building-first-app.md Outdated
@burtenshaw

Copy link
Copy Markdown
Collaborator Author

this is very cool, thanks for adding these guides @burtenshaw! I left some suggestions

Thanks @hanouticelina ! I've committed your suggestions.

@burtenshaw

Copy link
Copy Markdown
Collaborator Author

Thanks @Vaibhavs10 @hanouticelina. All done. Could I get an approval please?

@hanouticelina hanouticelina left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm, thank you! (sorry for the delay!)

@burtenshaw
burtenshaw merged commit c0e055b into main Jul 3, 2025
2 checks passed
@burtenshaw
burtenshaw deleted the improve-inference-providers-documentation branch July 3, 2025 08:31
provider: "auto"
});

return output.text || output || 'Transcription completed';

@julien-c julien-c Jul 7, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

(nit)

return output.text ?? output ?? 'Transcription completed';

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants