huggingface
diff --git a/‎README.md
Lines changed: 56 additions & 29 deletions
8000 b/‎README.md
Lines changed: 56 additions & 29 deletions
8000
@@ -9,12 +9,28 @@
   <br/>
 </p>
 
+```ts
+await inference.translation({
+  model: 't5-base',
+  inputs: 'My name is Wolfgang and I live in Berlin'
+})
+
+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',
+  }
+})
+```
+
 # Hugging Face JS libraries
 
 This is a collection of JS libraries to interact with the Hugging Face API, with TS types included.
 
+- [@huggingface/inference](packages/inference/README.md): Use the Inference API to make calls to 100,000+ Machine Learning models, or your own [inference endpoints](https://hf.co/docs/inference-endpoints/)!
 - [@huggingface/hub](packages/hub/README.md): Interact with huggingface.co to create or delete repos and commit / download files
-- [@huggingface/inference](packages/inference/README.md): Use the Inference API to make calls to 100,000+ Machine Learning models, or to your own [inference endpoints](https://hf.co/docs/inference-endpoints/)!
+
 
 With more to come, like `@huggingface/endpoints` to manage your HF Endpoints!
 
@@ -29,15 +45,15 @@ The libraries are still very young, please help us by opening issues!
 To install via NPM, you can download the libraries as needed:
 
 ```bash
-npm install @huggingface/hub
 npm install @huggingface/inference
+npm install @huggingface/hub
 ```
 
 Then import the libraries in your code:
 
 ```ts
-import { createRepo, commit, deleteRepo, listFiles } from "@huggingface/hub";
 import { HfInference } from "@huggingface/inference";
+import { createRepo, commit, deleteRepo, listFiles } from "@huggingface/hub";
 import type { RepoId, Credentials } from "@huggingface/hub";
 ```
 
@@ -53,36 +69,17 @@ You can run our packages with vanilla JS, without any bundler, by using a CDN or
 </script>
 ```
 
-## Usage example
+## Usage examples
+
+Get your HF access token in your [account settings](https://huggingface.co/settings/tokens).
+
+### @huggingface/inference examples
 
 ```ts
-import { createRepo, uploadFile, deleteFiles } from "@huggingface/hub";
 import { HfInference } from "@huggingface/inference";
 
-// use an access token from your free account
 const HF_ACCESS_TOKEN = "hf_...";
 
-await createRepo({
-  repo: "my-user/nlp-model", // or {type: "model", name: "my-user/nlp-test"},
-  credentials: {accessToken: HF_ACCESS_TOKEN}
-});
-
-await uploadFile({
-  repo: "my-user/nlp-model",
-  credentials: {accessToken: HF_ACCESS_TOKEN},
-  // Can work with native File in browsers
-  file: {
-    path: "pytorch_model.bin",
-    content: new Blob(...) 
-  }
-});
-
-await deleteFiles({
-  repo: {type: "space", name: "my-user/my-space"}, // or "spaces/my-user/my-space"
-  credentials: {accessToken: HF_ACCESS_TOKEN},
-  paths: ["README.md", ".gitattributes"]
-});
-
 const inference = new HfInference(HF_ACCESS_TOKEN);
 
 await inference.translation({
@@ -91,8 +88,8 @@ await inference.translation({
 })
 
 await inference.textToImage({
-  inputs: 'award winning high resolution photo of a giant tortoise/((ladybird)) hybrid, [trending on artstation]',
   model: 'stabilityai/stable-diffusion-2',
+  inputs: 'award winning high resolution photo of a giant tortoise/((ladybird)) hybrid, [trending on artstation]',
   parameters: {
     negative_prompt: 'blurry',
   }
@@ -103,11 +100,41 @@ await inference.imageToText({
   model: 'nlpconnect/vit-gpt2-image-captioning',  
 })
 
+
 // Using your own inference endpoint: https://hf.co/docs/inference-endpoints/
-const gpt2 = hf.endpoint('https://xyz.eu-west-1.aws.endpoints.huggingface.cloud/gpt2');
+const gpt2 = inference.endpoint('https://xyz.eu-west-1.aws.endpoints.huggingface.cloud/gpt2');
 const { generated_text } = await gpt2.textGeneration({inputs: 'The answer to the universe is'});
 ```
 
+### @huggingface/hub examples
+
+```ts
+import { createRepo, uploadFile, deleteFiles } from "@huggingface/hub";
+
+const HF_ACCESS_TOKEN = "hf_...";
+
+await createRepo({
+  repo: "my-user/nlp-model", // or {type: "model", name: "my-user/nlp-test"},
+  credentials: {accessToken: HF_ACCESS_TOKEN}
+});
+
+await uploadFile({
+  repo: "my-user/nlp-model",
+  credentials: {accessToken: HF_ACCESS_TOKEN},
+  // Can work with native File in browsers
+  file: {
+    path: "pytorch_model.bin",
+    content: new Blob(...) 
+  }
+});
+
+await deleteFiles({
+  repo: {type: "space", name: "my-user/my-space"}, // or "spaces/my-user/my-space"
+  credentials: {accessToken: HF_ACCESS_TOKEN},
+  paths: ["README.md", ".gitattributes"]
+});
+```
+
 There are more features of course, check each library's README!
 
 ## Formatting & testing