-
Notifications
You must be signed in to change notification settings - Fork 350
[inference providers] reorder menu #1876
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
base: main
Are you sure you want to change the base?
Conversation
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. |
title: Function Calling | ||
- local: guides/gpt-oss | ||
title: How to use OpenAI gpt-oss | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would also put the task guides (like "chat completion", "text-to-image") below the guides, rather than below the individual providers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So that would mean moving the API reference up? That's in here: 913c9d3
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, technically I only consider the "index" and "hub API" to be API reference, those can indeed be the final section. However the "popular tasks" like "chat completion", "feature extraction" etc. aren't API reference to me (they explain the various tasks, so they belong to "guides" imo rather than "API reference")
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah. That makes sense to me. I'll order it as you suggest and then hang on for another review, just because it's moved around a few times already.
it's in 77b8230
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Next up requests: add image-to-image and VLM task guides.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a bit weird to me that API Reference | Index
just points to tasks that are now located several levels above. Perhaps we could do something like:
- Add
tasks/index
back to the first item of theTasks
section. Change the title fromAPI Reference
to something likeInference Tasks
. - Keep the
Hub API
item last, if required, but call the sectionHub API
instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thought about it a bit, I don't have strong intuition about the order, would let @julien-c @Wauplin @hanouticelina chime in.
(probably better to wait till at least Wednesday before merge)
This pull request reorganizes the Documentation structure reorganization:
|
This pull request reorganizes the structure of the Documentation structure reorganization
|
This pull request reorganizes the Documentation structure reorganization:
|
@tasal9 are you paid per comment? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @burtenshaw for opening this and @NielsRogge @pcuenca @Vaibhavs10 for the suggestions. Current proposition looks good to me expect the last two items that I would group in a new section. No strong opinion on the rest so pre-approving right now
title: Hub API | ||
|
||
- local: register-as-a-provider | ||
title: Register as an Inference Provider |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- local: hub-api | |
title: Hub API | |
- local: register-as-a-provider | |
title: Register as an Inference Provider | |
- title: Advanced | |
sections: | |
- local: hub-api | |
title: Hub API | |
- local: register-as-a-provider | |
title: Register as an Inference Provider |
I would put these two in a grouped section for consistency. I'm fine with something like "Other" or "Misc" as well
|
||
- title: API Reference | ||
- local: tasks/index | ||
title: Inference Tasks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes perfect sense to rename this section, thanks for the suggestion 👍
title: Zero Shot Classification | ||
|
||
- title: Providers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no strong opinion whether to have "providers" below or above "tasks". Previous logic was to display our partners prominently but fine with moving them down if you prefer
This PR reorders the menu in inference providers.
(x-posting internal slack convo)