Skip to content
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

improve documentation for registry providers #198

Closed
dlqqq opened this issue May 30, 2023 · 2 comments
Closed

improve documentation for registry providers #198

dlqqq opened this issue May 30, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dlqqq
Copy link
Member

dlqqq commented May 30, 2023

Problem

Registry providers like SM Endpoints and HF Hub lack clear documentation on how the model IDs are determined. Right now, we direct users to a provider's upstream documentation, but that doesn't help the user determine what model ID to specify.

We need to explicitly state how the local model ID is determined for each of the registry providers in the following areas of documentation:

  • User documentation on RTD
  • %ai list

Proposed Solution

Below is the current table of providers being shown in the user documentation on RTD. I would like to see an additional column in this table that:

  • For non-registry providers: shows a collapsible list of valid local model IDs
  • For registry providers: provides guidance on how to specify the local model ID. e.g. for SM Endpoints, "the local model ID is the endpoint name".
Screen Shot 2023-05-30 at 1 42 37 PM

And similarly so for %ai list.

@dlqqq dlqqq added the enhancement New feature or request label May 30, 2023
@dlqqq dlqqq mentioned this issue May 30, 2023
@dlqqq dlqqq added the documentation Improvements or additions to documentation label May 30, 2023
@JasonWeill JasonWeill added this to the 0.10.0 Release milestone Jul 5, 2023
@JasonWeill JasonWeill self-assigned this Jul 5, 2023
@JasonWeill
Copy link
Collaborator

Because the list of models is dependent on LangChain, I think it would be best to keep the exact list of models dependent on a call to langchain made in the course of handling an %ai list command.

I can update the documentation and the %ai list handler to refer to documentation for HuggingFace and SageMaker endpoint providers.

@JasonWeill
Copy link
Collaborator

Fixed by #254.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants