transformers.js/docs/source/index.md

55 lines
1.5 KiB
Markdown

# Transformers.js
<include>
{
"path": "../snippets/0_introduction.snippet"
}
</include>
## Quick tour
<include>
{
"path": "../snippets/1_quick-tour.snippet"
}
</include>
## Contents
The documentation is organized into 4 sections:
1. **GET STARTED** provides a quick tour of the library and installation instructions to get up and running.
2. **TUTORIALS** are a great place to start if you're a beginner! We also include sample applications for you to play around with!
3. **DEVELOPER GUIDES** show you how to use the library to achieve a specific goal.
4. **API REFERENCE** describes all classes and functions, as well as their available parameters and types.
## Examples
<include>
{
"path": "../snippets/3_examples.snippet"
}
</include>
## Supported tasks/models
Here is the list of all tasks and architectures currently supported by Transformers.js.
If you don't see your task/model listed here or it is not yet supported, feel free
to open up a feature request [here](https://github.com/xenova/transformers.js/issues/new/choose).
To find compatible models on the Hub, select the "transformers.js" library tag in the filter menu (or visit [this link](https://huggingface.co/models?library=transformers.js)).
You can refine your search by selecting the task you're interested in (e.g., [text-classification](https://huggingface.co/models?pipeline_tag=text-classification&library=transformers.js)).
<include>
{
"path": "../snippets/5_supported-tasks.snippet"
}
</include>
<include>
{
"path": "../snippets/6_supported-models.snippet"
}
</include>