radames commited on
Commit
a937d9d
·
verified ·
1 Parent(s): 783836a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -30
README.md CHANGED
@@ -8,10 +8,20 @@ pinned: false
8
  ---
9
  # Hugging Face + Visual Blocks Custom Components
10
 
11
- <img src="https://huggingface.co/spaces/hf-vb/README/raw/main/hf-vb-logo.svg" width="250">
 
 
 
 
 
 
 
 
 
12
 
13
  Visual blocks is an amazing tool from our friends at [Google](https://github.com/google/visualblocks)
14
- that allows you to easily create and experiment with machine learning pipelines using a visual interface. This repository contains the source code for custom components that allow you to use Hugging Face client and server models in your Visual Blocks pipelines.
 
15
  We've created a few nodes supporting different tasks and models following our [Tasks](https://huggingface.co/tasks) definitions.
16
 
17
  > [!NOTE]
@@ -52,34 +62,34 @@ Important links:
52
 
53
  ## How to use the custom components
54
 
55
- To start playing with our custom components you need to Add a custom node to your Visual Blocks project. First you need to start a new project [https://visualblocks.withgoogle.com/#/edit/new](https://visualblocks.withgoogle.com/#/edit/new), then click on the "+" button in the bottom left corner to add a new node.
56
 
57
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/left_button.png" width="150">
58
 
59
  Then input the pre-bundled code from our npm package. You can do this by pasting the following link into the input field and clicking "Submit":
60
 
61
- ```js
62
  https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest
63
  ```
64
 
65
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/custom_node.jpg" width="400">
66
 
67
  Then you will be able to see three Hugging Face Collections: Client, Server and Common.
68
 
69
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/collections.jpg" width="200">
70
 
71
  # Nodes and Examples
72
 
73
  ## Client Nodes
74
 
75
- Client nodes are nodes running tranformers pipelines on the client side using [Transformers.js](https://github.com/xenova/transformers.js) library. All Client nodes have an experimental WebGPU and WASM backend support, and models listed in the [Xenova](https://huggingface.co/Xenova) profile are supported.
76
 
77
  > [!NOTE]
78
- > WebGPU support on transformers.js is experimental and may not work on all devices, not all models are supported by WebGPU backend yet.
79
 
80
  ### Translation
81
 
82
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/translation.jpg" width="400">
83
 
84
  [**Translation Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/translation_client_.json)
85
 
@@ -90,7 +100,7 @@ More info:
90
 
91
  ### Token Classification
92
 
93
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/token.jpg" width="400">
94
 
95
  [**Token Classification Node Exampl**e](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/token_classification_client_.json)
96
 
@@ -101,7 +111,7 @@ More info:
101
 
102
  ### Text Classification
103
 
104
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/text-classification.jpg" width="400">
105
 
106
  [**Text Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/text_classification_client_.json)
107
 
@@ -112,7 +122,7 @@ More info:
112
 
113
  ### Object Detection
114
 
115
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/object-detc.jpg" width="400">
116
 
117
  [**Object Detection Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/object_detection_client_.json)
118
 
@@ -123,7 +133,7 @@ More info:
123
 
124
  ### Image Segmentation
125
 
126
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/segment.jpg" width="400">
127
 
128
  [**Image Segmentation Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/image_segmentation_client_.json)
129
 
@@ -134,7 +144,7 @@ More info:
134
 
135
  ### Image Classification
136
 
137
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/class.jpg" width="400">
138
 
139
  [**Image Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/image_classification_client_.json)
140
 
@@ -145,7 +155,7 @@ More info:
145
 
146
  ### Depth Estimation
147
 
148
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/dept-es.jpg" width="400">
149
 
150
  [Depth Estimation Node Example](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/depth_estimation_client_.json)
151
 
@@ -156,7 +166,7 @@ More info:
156
 
157
  ### Background Removal
158
 
159
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/removal.jpg" width="400">
160
 
161
  [**Background Removal Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/background_removal_client_.json)
162
 
@@ -169,19 +179,19 @@ Server nodes are nodes running Transformers pipeline tasks using the [Hugging Fa
169
 
170
  For server nodes you have the option to Login using your Hugging Face account to get more usage and access to private models. Using **Hugging Face Hub Login**
171
 
172
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/button-auth.jpg" width="150">
173
 
174
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/auth.jpg" width="300">
175
 
176
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/button-logged.jpg" width="150">
177
 
178
- If successful, you can **Apikey** directly from the **Hugging Face Hub Login** node.
179
 
180
  <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/logged.jpg" width="350">
181
 
182
  ### Text Generation and Chat Completion
183
 
184
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/chat-template.jpg" width="400">
185
 
186
  [**Chat Template Text Generation Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/chat_template_text_generation_server_.json)
187
 
@@ -191,7 +201,7 @@ More info:
191
 
192
  ### Fill Mask
193
 
194
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/fill-mask.jpg" width="400">
195
 
196
  [**Fill Mask Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/fill_mask_server_.json)
197
 
@@ -201,7 +211,7 @@ More info:
201
 
202
  ### Image Classification
203
 
204
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/image-class.jpg" width="400">
205
 
206
  [**Image Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/image_classification_server_.json)
207
 
@@ -211,7 +221,7 @@ More info:
211
 
212
  ### Summarization
213
 
214
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/summarization.jpg" width="400">
215
 
216
  [**Summarization Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/summarization_server_.json)
217
 
@@ -221,7 +231,7 @@ More info:
221
 
222
  ### Text Classification
223
 
224
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/text-class.jpg" width="400">
225
 
226
  [**Text Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/text_classification_server_.json)
227
 
@@ -231,7 +241,7 @@ More info:
231
 
232
  ### Text Generation
233
 
234
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/text-generation.jpg" width="400">
235
 
236
  [**Text Generation Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/text_generation_server_.json)
237
 
@@ -241,7 +251,7 @@ More info:
241
 
242
  ### Text to Image
243
 
244
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/text-to-image.jpg" width="400">
245
 
246
  [**Text to Image Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/text_to_image_server_.json)
247
 
@@ -251,7 +261,7 @@ More info:
251
 
252
  ### Token Classification
253
 
254
- <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/token-class.jpg" width="400">
255
 
256
  [**Token Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/token_classification_server_.json)
257
 
@@ -284,7 +294,8 @@ More info:
284
 
285
  5. Click the + in the bottom left corner to add the custom nodes.
286
 
287
- 6. Paste in the link to the script (http://localhost:8080/index.js) and click "Submit".
 
288
 
289
 
290
  # Hugging Face and Google Visual Blocks
 
8
  ---
9
  # Hugging Face + Visual Blocks Custom Components
10
 
11
+
12
+ <p align="center">
13
+ <br/>
14
+ <picture>
15
+ <source media="(prefers-color-scheme: dark)" srcset="https://huggingface.co/spaces/hf-vb/README/raw/main/hf-vb-logo-dark.svg" width="400" style="max-width: 100%;">
16
+ <source media="(prefers-color-scheme: light)" srcset="https://huggingface.co/spaces/hf-vb/README/raw/main/hf-vb-logo.svg" width="400" style="max-width: 100%;">
17
+ <img alt="transformers.js javascript library logo" src="https://huggingface.co/spaces/hf-vb/README/raw/main/hf-vb-logo.svg" width="400" style="max-width: 100%;">
18
+ </picture>
19
+ <br/>
20
+ </p>
21
 
22
  Visual blocks is an amazing tool from our friends at [Google](https://github.com/google/visualblocks)
23
+ that allows you to easily create and experiment with machine learning pipelines using a visual interface.
24
+ This repository contains the source code for custom components that allow you to use Hugging Face client and server models in your Visual Blocks pipelines.
25
  We've created a few nodes supporting different tasks and models following our [Tasks](https://huggingface.co/tasks) definitions.
26
 
27
  > [!NOTE]
 
62
 
63
  ## How to use the custom components
64
 
65
+ To start playing with our custom components you need to **Add a custom node** to your Visual Blocks project. First you need to start a new project [https://visualblocks.withgoogle.com/#/edit/new](https://visualblocks.withgoogle.com/#/edit/new), then click on the "+" button in the bottom left corner to add a new node.
66
 
67
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/left_button.png" width="200">
68
 
69
  Then input the pre-bundled code from our npm package. You can do this by pasting the following link into the input field and clicking "Submit":
70
 
71
+ ```
72
  https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest
73
  ```
74
 
75
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/custom_node.jpg" width="450">
76
 
77
  Then you will be able to see three Hugging Face Collections: Client, Server and Common.
78
 
79
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/collections.jpg" width="250">
80
 
81
  # Nodes and Examples
82
 
83
  ## Client Nodes
84
 
85
+ Client nodes are nodes running tranformers pipelines on the client side using [Transformers.js](https://github.com/xenova/transformers.js). All Client nodes have WASM and WebGPU (experimental) backend support, and you can find web-compatible models by visiting https://huggingface.co/models?library=transformers.js.
86
 
87
  > [!NOTE]
88
+ > WebGPU support in transformers.js is still experimental and may not work on all devices. Not all models are supported by WebGPU backend yet.
89
 
90
  ### Translation
91
 
92
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/translation.jpg" width="500">
93
 
94
  [**Translation Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/translation_client_.json)
95
 
 
100
 
101
  ### Token Classification
102
 
103
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/token.jpg" width="500">
104
 
105
  [**Token Classification Node Exampl**e](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/token_classification_client_.json)
106
 
 
111
 
112
  ### Text Classification
113
 
114
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/text-classification.jpg" width="500">
115
 
116
  [**Text Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/text_classification_client_.json)
117
 
 
122
 
123
  ### Object Detection
124
 
125
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/object-detc.jpg" width="500">
126
 
127
  [**Object Detection Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/object_detection_client_.json)
128
 
 
133
 
134
  ### Image Segmentation
135
 
136
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/segment.jpg" width="500">
137
 
138
  [**Image Segmentation Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/image_segmentation_client_.json)
139
 
 
144
 
145
  ### Image Classification
146
 
147
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/class.jpg" width="500">
148
 
149
  [**Image Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/image_classification_client_.json)
150
 
 
155
 
156
  ### Depth Estimation
157
 
158
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/dept-es.jpg" width="500">
159
 
160
  [Depth Estimation Node Example](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/depth_estimation_client_.json)
161
 
 
166
 
167
  ### Background Removal
168
 
169
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/removal.jpg" width="500">
170
 
171
  [**Background Removal Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/client/background_removal_client_.json)
172
 
 
179
 
180
  For server nodes you have the option to Login using your Hugging Face account to get more usage and access to private models. Using **Hugging Face Hub Login**
181
 
182
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/button-auth.jpg" width="250">
183
 
184
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/auth.jpg" width="400">
185
 
186
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/button-logged.jpg" width="250">
187
 
188
+ If successful, you can obtain your **Apikey** directly from the **Hugging Face Hub Login** node.
189
 
190
  <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/logged.jpg" width="350">
191
 
192
  ### Text Generation and Chat Completion
193
 
194
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/chat-template.jpg" width="500">
195
 
196
  [**Chat Template Text Generation Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/chat_template_text_generation_server_.json)
197
 
 
201
 
202
  ### Fill Mask
203
 
204
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/fill-mask.jpg" width="500">
205
 
206
  [**Fill Mask Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/fill_mask_server_.json)
207
 
 
211
 
212
  ### Image Classification
213
 
214
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/image-class.jpg" width="500">
215
 
216
  [**Image Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/image_classification_server_.json)
217
 
 
221
 
222
  ### Summarization
223
 
224
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/summarization.jpg" width="500">
225
 
226
  [**Summarization Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/summarization_server_.json)
227
 
 
231
 
232
  ### Text Classification
233
 
234
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/text-class.jpg" width="500">
235
 
236
  [**Text Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/text_classification_server_.json)
237
 
 
241
 
242
  ### Text Generation
243
 
244
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/text-generation.jpg" width="500">
245
 
246
  [**Text Generation Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/text_generation_server_.json)
247
 
 
251
 
252
  ### Text to Image
253
 
254
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/text-to-image.jpg" width="500">
255
 
256
  [**Text to Image Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/text_to_image_server_.json)
257
 
 
261
 
262
  ### Token Classification
263
 
264
+ <img src="https://huggingface.co/spaces/hf-vb/README/resolve/main/server/token-class.jpg" width="500">
265
 
266
  [**Token Classification Node Example**](https://visualblocks.withgoogle.com/#/edit/new_hfdemo?project_json=https://cdn.jsdelivr.net/npm/huggingface-visualblocks-nodes@latest/examples/server/token_classification_server_.json)
267
 
 
294
 
295
  5. Click the + in the bottom left corner to add the custom nodes.
296
 
297
+ 6. Paste in the link to the script (e.g., http://localhost:8080/index.js) and click "Submit".
298
+
299
 
300
 
301
  # Hugging Face and Google Visual Blocks