[inference providers] reorder menu #1876
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.
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.
So that would mean moving the API reference up? That's in here: 913c9d3
There was a problem hiding this comment.
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.
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
NielsRogge
left a comment
NielsRogge
left a comment
There was a problem hiding this comment.
Thanks! Next up requests: add image-to-image and VLM task guides.
pcuenca
left a comment
pcuenca
left a comment
There was a problem hiding this comment.
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/indexback to the first item of theTaskssection. Change the title fromAPI Referenceto something likeInference Tasks. - Keep the
Hub APIitem last, if required, but call the sectionHub APIinstead.
Vaibhavs10
left a comment
Vaibhavs10
left a comment
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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
| - local: hub-api | ||
| title: Hub API | ||
|
|
||
| - local: register-as-a-provider | ||
| title: Register as an Inference Provider No newline at end of file |
There was a problem hiding this comment.
| - 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
There was a problem hiding this comment.
what about keeping "API Reference"? otherwise Advanced sounds fine to me
There was a problem hiding this comment.
API Reference sounds tad bit nicer to me.
There was a problem hiding this comment.
feels a bit weird to have them free-standing:
|
|
||
| - title: API Reference | ||
| - local: tasks/index | ||
| title: Inference Tasks |
There was a problem hiding this comment.
Makes perfect sense to rename this section, thanks for the suggestion 👍
| title: Zero Shot Classification No newline at end of file | ||
| title: Zero Shot Classification | ||
|
|
||
| - title: Providers |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
fine for me as well as long as Providers are not too hidden. Given Tasks is short, i'm fine with it being above
| - local: tasks/feature-extraction | ||
| title: Feature Extraction | ||
| - local: tasks/text-to-image | ||
| title: Text to Image |
There was a problem hiding this comment.
I would also make Image-to-Image and VLMs separate task pages here (as follow-up PRs)
* reorder menu in inference providers * move api reference up * only move tasks up and leave api reference below providers * use Inference Tasks and Hub API
8 participants
This PR reorders the menu in inference providers.
(x-posting internal slack convo)