Merge branch 'main' into patch-1

.github/pull_request_template/new_library.md

@@ -0,0 +1,34 @@
+# What does this PR do?
+
+This PR adds support for the library [TO BE COMPLETED].
+
+Link to library repo: [TO BE COMPLETED].
+
+Link to models on the Hub: https://huggingface.co/models?other=[to-be-completed].
+
+## Main instructions
+
+Please check that all prerequisites are met.
+
+- [ ] A new library has been added to [model-libraries.ts](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries.ts#L60).
+- [ ] The alphabetical order of `MODEL_LIBRARIES_UI_ELEMENTS` has been preserved.
+- [ ] The library id is lowercased and hyphen-separated (example: `"adapter-transformers"`).
+- [ ] At least one model is referenced on https://huggingface.co/models?other=my-library-name. If not, the model card metadata of the relevant models must be updated to add `library_name: my-library-name` (see [example](https://huggingface.co/google/gemma-scope/blob/main/README.md?code=true#L3)). If you are not the owner of the models on the Hub, please open PRs (see [example](https://huggingface.co/MCG-NJU/VFIMamba/discussions/1)). **Note:** if no models are listed, this PR won't be merged.
+- [ ] `repoName` and `prettyLabel` are set with user-friendly casing (example: `DeepForest`).
+- [ ] `repoUrl` is set with a link to the library source code (usually a GitHub repository).
+- [ ] (optional) `docsUrl` is set with a link to the docs of the library. If the documentation is in the GitHub repo referenced above, no need to set it twice.
+- [ ] `filter` is set to `false`.
+- [ ] `countDownload` follows the correct convention and do not duplicate the counting. For instance, if loading a model requires 3 files, the download count rule must count downloads only on 1 of the 3 files. Otherwise, the download count will be overestimated. If the library uses one of the default config files (`config.json`, `config.yaml`, `hyperparams.yaml`, and `meta.yaml`, see [here](https://huggingface.co/docs/hub/models-download-stats#which-are-the-query-files-for-different-libraries)), there is no need to manually define a download count rule.
+- [ ] (optional) `snippets` is correctly defined. See check-list below.
+- [ ] Make sure that the code passes the linter test as well
+
+## (optional) Snippets instructions
+
+Adding a code snippet helps users to start using your library. It is especially useful when the library is tightly integrated with the Hub and typically has a `Model.from_pretrained` helper method. Check out [this guide](https://huggingface.co/docs/huggingface_hub/guides/download) to learn how to download files in Python and [this guide](https://huggingface.co/docs/huggingface_hub/guides/integrations) for a broader explanation on how to integrate a library with the Hub. Note that adding a code snippet is optional.
+For code snippets specifically, please refer to this checklist:
+
+- [ ] Code snippet has been defined in [model-libraries-snippets.ts](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries-snippets.ts) and added to [model-libraries.ts](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries.ts#L60).
+- [ ] Code snippet does not contain installation instruction.
+- [ ] Code snippet is minimal (only loading / calling the model with simple config).
+- [ ] (recommended) Code snippet is generated from `ModelData`, typically to get the correct command to load a specific model.
+- [ ] (optional) It's possible to define multiple code snippets (by returning a list) to showcase different usage.

.github/workflows/agents-publish.yml

@@ -50,7 +50,7 @@ jobs:
           node -e "const fs = require('fs'); const package = JSON.parse(fs.readFileSync('./package.json')); package.version = '$BUMPED_VERSION'; fs.writeFileSync('./package.json', JSON.stringify(package, null, '\t') + '\n');"
           pnpm --filter doc-internal run fix-cdn-versions
           git add ../..
-          git commit -m "🔖 @hugginface/agents $BUMPED_VERSION"
+          git commit -m "🔖 @huggingface/agents $BUMPED_VERSION"
           git tag "agents-v$BUMPED_VERSION"
       - run: pnpm --filter agents... build && pnpm publish --no-git-checks .
         env:
@@ -61,10 +61,12 @@ jobs:
         with:
           node-version: "20"
           registry-url: "https://npm.pkg.github.com"
-      - run: pnpm publish --no-git-checks .
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558)
+      # - run: pnpm publish --no-git-checks .
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Update Doc"
         uses: peter-evans/repository-dispatch@v2
         with:
           event-type: doc-build
+          token: ${{ secrets.BOT_ACCESS_TOKEN }}

.github/workflows/gguf-publish.yml

@@ -47,7 +47,7 @@ jobs:
           BUMPED_VERSION=$(node -p "require('semver').inc('$PACKAGE_VERSION', '${{ github.event.inputs.newversion }}')")
           # Update package.json with the new version
           node -e "const fs = require('fs'); const package = JSON.parse(fs.readFileSync('./package.json')); package.version = '$BUMPED_VERSION'; fs.writeFileSync('./package.json', JSON.stringify(package, null, '\t') + '\n');"
-          git commit . -m "🔖 @hugginface/gguf $BUMPED_VERSION"
+          git commit . -m "🔖 @huggingface/gguf $BUMPED_VERSION"
           git tag "gguf-v$BUMPED_VERSION"
       - run: pnpm publish --no-git-checks .
         env:
@@ -58,6 +58,7 @@ jobs:
         with:
           node-version: "20"
           registry-url: "https://npm.pkg.github.com"
-      - run: pnpm publish --no-git-checks .
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558)
+      # - run: pnpm publish --no-git-checks .
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/hub-publish.yml

@@ -50,7 +50,7 @@ jobs:
           node -e "const fs = require('fs'); const package = JSON.parse(fs.readFileSync('./package.json')); package.version = '$BUMPED_VERSION'; fs.writeFileSync('./package.json', JSON.stringify(package, null, '\t') + '\n');"
           pnpm --filter doc-internal run fix-cdn-versions
           git add ../..
-          git commit -m "🔖 @hugginface/hub $BUMPED_VERSION"
+          git commit -m "🔖 @huggingface/hub $BUMPED_VERSION"
           git tag "hub-v$BUMPED_VERSION"
 
       - name: Make sure that the latest version of @huggingface/tasks is consistent with the local version
@@ -99,10 +99,12 @@ jobs:
         with:
           node-version: "20"
           registry-url: "https://npm.pkg.github.com"
-      - run: pnpm publish --no-git-checks .
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558)
+      # - run: pnpm publish --no-git-checks .
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Update Doc"
         uses: peter-evans/repository-dispatch@v2
         with:
           event-type: doc-build
+          token: ${{ secrets.BOT_ACCESS_TOKEN }}

.github/workflows/inference-publish.yml

@@ -50,7 +50,7 @@ jobs:
           node -e "const fs = require('fs'); const package = JSON.parse(fs.readFileSync('./package.json')); package.version = '$BUMPED_VERSION'; fs.writeFileSync('./package.json', JSON.stringify(package, null, '\t') + '\n');"
           pnpm --filter doc-internal run fix-cdn-versions
           git add ../..
-          git commit -m "🔖 @hugginface/inference $BUMPED_VERSION"
+          git commit -m "🔖 @huggingface/inference $BUMPED_VERSION"
           git tag "inference-v$BUMPED_VERSION"
 
       - name: Make sure that the latest version of @huggingface/tasks is consistent with the local version
@@ -99,6 +99,7 @@ jobs:
         with:
           node-version: "20"
           registry-url: "https://npm.pkg.github.com"
-      - run: pnpm publish --no-git-checks .
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558)
+      # - run: pnpm publish --no-git-checks .
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/jinja-publish.yml

@@ -47,7 +47,7 @@ jobs:
           BUMPED_VERSION=$(node -p "require('semver').inc('$PACKAGE_VERSION', '${{ github.event.inputs.newversion }}')")
           # Update package.json with the new version
           node -e "const fs = require('fs'); const package = JSON.parse(fs.readFileSync('./package.json')); package.version = '$BUMPED_VERSION'; fs.writeFileSync('./package.json', JSON.stringify(package, null, '\t') + '\n');"
-          git commit . -m "🔖 @hugginface/jinja $BUMPED_VERSION"
+          git commit . -m "🔖 @huggingface/jinja $BUMPED_VERSION"
           git tag "jinja-v$BUMPED_VERSION"
       - run: pnpm publish --no-git-checks .
         env:
@@ -58,6 +58,7 @@ jobs:
         with:
           node-version: "20"
           registry-url: "https://npm.pkg.github.com"
-      - run: pnpm publish --no-git-checks .
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558)
+      # - run: pnpm publish --no-git-checks .
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/languages-publish.yml

@@ -47,7 +47,7 @@ jobs:
           BUMPED_VERSION=$(node -p "require('semver').inc('$PACKAGE_VERSION', '${{ github.event.inputs.newversion }}')")
           # Update package.json with the new version
           node -e "const fs = require('fs'); const package = JSON.parse(fs.readFileSync('./package.json')); package.version = '$BUMPED_VERSION'; fs.writeFileSync('./package.json', JSON.stringify(package, null, '\t') + '\n');"
-          git commit . -m "🔖 @hugginface/languages $BUMPED_VERSION"
+          git commit . -m "🔖 @huggingface/languages $BUMPED_VERSION"
           git tag "languages-v$BUMPED_VERSION"
       - run: pnpm publish --no-git-checks .
         env:
@@ -58,6 +58,7 @@ jobs:
         with:
           node-version: "20"
           registry-url: "https://npm.pkg.github.com"
-      - run: pnpm publish --no-git-checks .
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558)
+      # - run: pnpm publish --no-git-checks .
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/space-header-publish.yml

@@ -47,7 +47,7 @@ jobs:
           BUMPED_VERSION=$(node -p "require('semver').inc('$PACKAGE_VERSION', '${{ github.event.inputs.newversion }}')")
           # Update package.json with the new version
           node -e "const fs = require('fs'); const package = JSON.parse(fs.readFileSync('./package.json')); package.version = '$BUMPED_VERSION'; fs.writeFileSync('./package.json', JSON.stringify(package, null, '\t') + '\n');"
-          git commit . -m "🔖 @hugginface/space-header $BUMPED_VERSION"
+          git commit . -m "🔖 @huggingface/space-header $BUMPED_VERSION"
           git tag "space-header-v$BUMPED_VERSION"
       - run: pnpm publish --no-git-checks .
         env:
@@ -58,10 +58,12 @@ jobs:
         with:
           node-version: "20"
           registry-url: "https://npm.pkg.github.com"
-      - run: pnpm publish --no-git-checks .
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558)
+      # - run: pnpm publish --no-git-checks .
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Update Doc"
         uses: peter-evans/repository-dispatch@v2
         with:
           event-type: doc-build
+          token: ${{ secrets.BOT_ACCESS_TOKEN }}

.github/workflows/tasks-publish.yml

@@ -47,7 +47,7 @@ jobs:
           BUMPED_VERSION=$(node -p "require('semver').inc('$PACKAGE_VERSION', '${{ github.event.inputs.newversion }}')")
           # Update package.json with the new version
           node -e "const fs = require('fs'); const package = JSON.parse(fs.readFileSync('./package.json')); package.version = '$BUMPED_VERSION'; fs.writeFileSync('./package.json', JSON.stringify(package, null, '\t') + '\n');"
-          git commit . -m "🔖 @hugginface/tasks $BUMPED_VERSION"
+          git commit . -m "🔖 @huggingface/tasks $BUMPED_VERSION"
           git tag "tasks-v$BUMPED_VERSION"
       - run: pnpm publish --no-git-checks .
         env:
@@ -58,10 +58,12 @@ jobs:
         with:
           node-version: "20"
           registry-url: "https://npm.pkg.github.com"
-      - run: pnpm publish --no-git-checks .
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558)
+      # - run: pnpm publish --no-git-checks .
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Update Doc"
         uses: peter-evans/repository-dispatch@v2
         with:
           event-type: doc-build
+          token: ${{ secrets.BOT_ACCESS_TOKEN }}

.github/workflows/widgets-publish.yml

@@ -170,6 +170,7 @@ jobs:
         with:
           node-version: "20"
           registry-url: "https://npm.pkg.github.com"
-      - run: pnpm publish --no-git-checks .
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558)
+      # - run: pnpm publish --no-git-checks .
+      #   env:
+      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -14,33 +14,37 @@
 
 await createRepo({
   repo: {type: "model", name: "my-user/nlp-model"},
-  credentials: {accessToken: HF_TOKEN}
+  accessToken: HF_TOKEN
 });
 
 await uploadFile({
   repo: "my-user/nlp-model",
-  credentials: {accessToken: HF_TOKEN},
+  accessToken: HF_TOKEN,
   // Can work with native File in browsers
   file: {
     path: "pytorch_model.bin",
     content: new Blob(...) 
   }
 });
 
-// Use hosted inference
-
-await inference.translation({
-  model: 't5-base',
-  inputs: 'My name is Wolfgang and I live in Berlin'
-})
+// Use Inference API
+
+await inference.chatCompletion({
+  model: "meta-llama/Llama-3.1-8B-Instruct",
+  messages: [
+    {
+      role: "user",
+      content: "Hello, nice to meet you!",
+    },
+  ],
+  max_tokens: 512,
+  temperature: 0.5,
+});
 
 await inference.textToImage({
-  model: 'stabilityai/stable-diffusion-2',
-  inputs: 'award winning high resolution photo of a giant tortoise/((ladybird)) hybrid, [trending on artstation]',
-  parameters: {
-    negative_prompt: 'blurry',
-  }
-})
+  model: "black-forest-labs/FLUX.1-dev",
+  inputs: "a picture of a green bird",
+});
 
 // and much more…
 ```
@@ -79,7 +83,7 @@ Then import the libraries in your code:
 import { HfInference } from "@huggingface/inference";
 import { HfAgent } from "@huggingface/agents";
 import { createRepo, commit, deleteRepo, listFiles } from "@huggingface/hub";
-import type { RepoId, Credentials } from "@huggingface/hub";
+import type { RepoId } from "@huggingface/hub";
 ```
 
 ### From CDN or Static hosting
@@ -88,8 +92,8 @@ You can run our packages with vanilla JS, without any bundler, by using a CDN or
 
 ```html
 <script type="module">
-    import { HfInference } from 'https://cdn.jsdelivr.net/npm/@huggingface/inference@2.8.0/+esm';
-    import { createRepo, commit, deleteRepo, listFiles } from "https://cdn.jsdelivr.net/npm/@huggingface/hub@0.15.1/+esm";
+    import { HfInference } from 'https://cdn.jsdelivr.net/npm/@huggingface/inference@2.8.1/+esm';
+    import { createRepo, commit, deleteRepo, listFiles } from "https://cdn.jsdelivr.net/npm/@huggingface/hub@0.18.1/+esm";
 </script>
 ```
 
@@ -123,33 +127,33 @@ const inference = new HfInference(HF_TOKEN);
 
 // Chat completion API
 const out = await inference.chatCompletion({
-  model: "mistralai/Mistral-7B-Instruct-v0.2",
-  messages: [{ role: "user", content: "Complete the this sentence with words one plus one is equal " }],
-  max_tokens: 100
+  model: "meta-llama/Llama-3.1-8B-Instruct",
+  messages: [{ role: "user", content: "Hello, nice to meet you!" }],
+  max_tokens: 512
 });
 console.log(out.choices[0].message);
 
 // Streaming chat completion API
 for await (const chunk of inference.chatCompletionStream({
-  model: "mistralai/Mistral-7B-Instruct-v0.2",
-  messages: [{ role: "user", content: "Complete the this sentence with words one plus one is equal " }],
-  max_tokens: 100
+  model: "meta-llama/Llama-3.1-8B-Instruct",
+  messages: [{ role: "user", content: "Hello, nice to meet you!" }],
+  max_tokens: 512
 })) {
   console.log(chunk.choices[0].delta.content);
 }
 
 // You can also omit "model" to use the recommended model for the task
-await inference.translation({
-  model: 't5-base',
-  inputs: 'My name is Wolfgang and I live in Amsterdam'
-})
+await hf.translation({
+  inputs: "My name is Wolfgang and I live in Amsterdam",
+  parameters: {
+    src_lang: "en",
+    tgt_lang: "fr",
+  },
+});
 
 await inference.textToImage({
-  model: 'stabilityai/stable-diffusion-2',
-  inputs: 'award winning high resolution photo of a giant tortoise/((ladybird)) hybrid, [trending on artstation]',
-  parameters: {
-    negative_prompt: 'blurry',
-  }
+  model: 'black-forest-labs/FLUX.1-dev',
+  inputs: 'a picture of a green bird',
 })
 
 await inference.imageToText({
@@ -162,13 +166,13 @@ const gpt2 = inference.endpoint('https://xyz.eu-west-1.aws.endpoints.huggingface
 const { generated_text } = await gpt2.textGeneration({inputs: 'The answer to the universe is'});
 
 //Chat Completion
-const mistal = inference.endpoint(
- "https://api-inference.huggingface.co/models/mistralai/Mistral-7B-Instruct-v0.2"
+const llamaEndpoint = inference.endpoint(
+ "https://api-inference.huggingface.co/models/meta-llama/Llama-3.1-8B-Instruct"
 );
-const out = await mistal.chatCompletion({
- model: "mistralai/Mistral-7B-Instruct-v0.2",
- messages: [{ role: "user", content: "Complete the this sentence with words one plus one is equal " }],
- max_tokens: 100,
+const out = await llamaEndpoint.chatCompletion({
+ model: "meta-llama/Llama-3.1-8B-Instruct",
+ messages: [{ role: "user", content: "Hello, nice to meet you!" }],
+ max_tokens: 512,
 });
 console.log(out.choices[0].message);
 ```
@@ -182,12 +186,12 @@ const HF_TOKEN = "hf_...";
 
 await createRepo({
   repo: "my-user/nlp-model", // or {type: "model", name: "my-user/nlp-test"},
-  credentials: {accessToken: HF_TOKEN}
+  accessToken: HF_TOKEN
 });
 
 await uploadFile({
   repo: "my-user/nlp-model",
-  credentials: {accessToken: HF_TOKEN},
+  accessToken: HF_TOKEN,
   // Can work with native File in browsers
   file: {
     path: "pytorch_model.bin",
@@ -197,7 +201,7 @@ await uploadFile({
 
 await deleteFiles({
   repo: {type: "space", name: "my-user/my-space"}, // or "spaces/my-user/my-space"
-  credentials: {accessToken: HF_TOKEN},
+  accessToken: HF_TOKEN,
   paths: ["README.md", ".gitattributes"]
 });
 ```

packages/doc-internal/README.md

@@ -2,7 +2,7 @@
 
 This package generates `.md` files inside the [docs](../../docs) folder using [typedoc](https://typedoc.org/) and [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown).
 
-The `.md` files are generated when releasing packages. They are then published to [hugginface.co](https://huggingface.co/docs/huggingface.js/index) through the [doc-builder](https://github.com/huggingface/doc-builder)'s github action.
+The `.md` files are generated when releasing packages. They are then published to [huggingface.co](https://huggingface.co/docs/huggingface.js/index) through the [doc-builder](https://github.com/huggingface/doc-builder)'s github action.
 
 We run a few scripts in between, [fix-md-links](./fix-md-links.ts) and [update-toc](./update-toc.ts) to preprocess the files for `doc-builder`.