Standardize references to file #1136
Conversation
mishig25
requested review from
osanseviero,
coyotte508,
julien-c,
merveenoyan and
EziOzoani
|
The documentation is not available anymore as the PR was closed or merged. |
|
On tasks' end I'm in favor of keeping existing ones for the sake of readability, unless we have any other objection. |
| @@ -184,7 +184,7 @@ All third-party libraries are Dockerized, so you can install the dependencies yo | |||
|
|
|||
| ### Register your libraries supported tasks on the hub | |||
|
|
|||
| To register the tasks supported by your library on the hub you'll need to add a mapping from your library name to its supported tasks in this [file](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/library-to-tasks.ts). This will ensure the inference API is registered for tasks supported by your model. This file is automatically generated as part of a [GitHub Action](https://github.com/huggingface/api-inference-community/actions/workflows/python-api-export-tasks.yaml) in the [ | |||
| To register the tasks supported by your library on the hub you'll need to add a mapping from your library name to its supported tasks in [library-to-tasks.ts file](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/library-to-tasks.ts). This will ensure the inference API is registered for tasks supported by your model. This file is automatically generated as part of a [GitHub Action](https://github.com/huggingface/api-inference-community/actions/workflows/python-api-export-tasks.yaml) in the [ | |||
There was a problem hiding this comment.
I find this a bit confusing. It says you have to edit the file and then that it's automatically generated. The GitHub action generates something similar, to the .ts file; for example, audio-source-separation is commented in the .ts file but not in the generated result.
My understanding is that the GitHub action provides the source of truth to the inference API, but I don't fully understand the workflow or relationship with library-to-tasks.ts.
There was a problem hiding this comment.
yes we should definitely add an automated workflow to update hf.js and link to https://github.com/huggingface/api-inference-community directly
There was a problem hiding this comment.
See this PR: huggingface/api-inference-community#355
mishig25
force-pushed
the
reference_file_names
branch
from
3ff6853 to
d8329ac
Compare
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
Nit: I've noticed that references to files could be standardized bit more while working on #1135