@eyepop.ai/eyepop-render-2d 3.17.3 → 3.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -2
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -141,7 +141,7 @@ Most prebuild render classes provide a reasonable defaults, as shown below.
141
141
  Render2d.renderBox({
142
142
  showClass: true,
143
143
  showConfidence: false,
144
- showTraceId: false,
144
+ showTrackId: false,
145
145
  showNestedClasses: false,
146
146
  target: '$..objects.*',
147
147
  })
@@ -180,6 +180,29 @@ Render2d.renderText({
180
180
  })
181
181
  ```
182
182
 
183
+ #### Render Classification Labels
184
+
185
+ Renders whole-image classification labels. Defaults shown:
186
+
187
+ ```typescript
188
+ Render2d.renderClasses({
189
+ showConfidence: false,
190
+ labelSizePercentage: 0.05,
191
+ target: '$',
192
+ })
193
+ ```
194
+
195
+ #### Render Key Points
196
+
197
+ Renders key points for any object that carries them. Defaults shown:
198
+
199
+ ```typescript
200
+ Render2d.renderKeypoints({
201
+ showLabels: false,
202
+ target: '$..objects[?(@.keyPoints)]',
203
+ })
204
+ ```
205
+
183
206
  #### Render Segmentation Masks
184
207
 
185
208
  ```typescript
@@ -196,7 +219,7 @@ Render2d.renderContour({
196
219
  })
197
220
  ```
198
221
 
199
- #### Blur an Object (TODO does black-put instead of blur)
222
+ #### Blur an Object
200
223
 
201
224
  ```typescript
202
225
  Render2d.renderBlur({
@@ -204,6 +227,8 @@ Render2d.renderBlur({
204
227
  })
205
228
  ```
206
229
 
230
+ Note: this currently paints a solid fill over the object rather than applying a true blur.
231
+
207
232
  #### Render a Trail of a traced object over time
208
233
 
209
234
  ```typescript
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eyepop.ai/eyepop-render-2d",
3
- "version": "3.17.3",
3
+ "version": "3.18.0",
4
4
  "description": "The Node.js / Typescript library for 2d rendering of EyePop.ai's inference API",
5
5
  "keywords": [
6
6
  "AI",
@@ -36,7 +36,7 @@
36
36
  "dev": "tsup && webpack; npx chokidar '**/*.ts' -i 'dist' -c 'npx tsup && webpack'"
37
37
  },
38
38
  "dependencies": {
39
- "@eyepop.ai/eyepop": "3.17.3",
39
+ "@eyepop.ai/eyepop": "3.18.0",
40
40
  "@juggle/resize-observer": "^3.4.0",
41
41
  "@types/jsonpath": "^0.2.4",
42
42
  "canvas": "3.2.0",