Skip to content

Commit 4bbb2c4

Browse files
JakubGoneraJakubGonera
authored
docs: update C++ changes (#365)
## Description Change documentation that is influenced by C++ ports ### Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] Documentation update (improves or adds clarity to existing documentation) ### Related issues #255
1 parent 3e63895 commit 4bbb2c4

5 files changed

Lines changed: 67 additions & 43 deletions

File tree

‎docs/docs/computer-vision/useObjectDetection.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ For more information on that topic, you can check out the [Loading models](https
6060

6161
The hook returns an object with the following properties:
6262

63-
| Field | Type | Description |
64-
| ------------------ | ----------------------------------------- | ---------------------------------------------------------------------------------------- |
65-
| `forward` | `(input: string) => Promise<Detection[]>` | A function that accepts an image (url, b64) and returns an array of `Detection` objects. |
66-
| `error` | <code>string &#124; null</code> | Contains the error message if the model loading failed. |
67-
| `isGenerating` | `boolean` | Indicates whether the model is currently processing an inference. |
68-
| `isReady` | `boolean` | Indicates whether the model has successfully loaded and is ready for inference. |
69-
| `downloadProgress` | `number` | Represents the download progress as a value between 0 and 1. |
63+
| Field | Type | Description |
64+
| ------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
65+
| `forward` | `(input: string, detectionThreshold: number = 0.7) => Promise<Detection[]>` | A function that accepts an image (url, b64) and returns an array of `Detection` objects. `detectionThreshold` can be supplied to alter the sensitivity of the detection. |
66+
| `error` | <code>string &#124; null</code> | Contains the error message if the model loading failed. |
67+
| `isGenerating` | `boolean` | Indicates whether the model is currently processing an inference. |
68+
| `isReady` | `boolean` | Indicates whether the model has successfully loaded and is ready for inference. |
69+
| `downloadProgress` | `number` | Represents the download progress as a value between 0 and 1. |
7070

7171
## Running the model
7272

‎docs/docs/typescript-api/ClassificationModule.md‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,22 @@ import {
1414

1515
const imageUri = 'path/to/image.png';
1616

17+
const module = new ClassificationModule();
18+
1719
// Loading the model
18-
await ClassificationModule.load(EFFICIENTNET_V2_S);
20+
await module.load(EFFICIENTNET_V2_S);
1921

2022
// Running the model
21-
const classesWithProbabilities = await ClassificationModule.forward(imageUri);
23+
const classesWithProbabilities = await module.forward(imageUri);
2224
```
2325

2426
### Methods
2527

26-
| Method | Type | Description |
27-
| -------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
28-
| `load` | `(modelSource: ResourceSource): Promise<void>` | Loads the model, where `modelSource` is a string that specifies the location of the model binary. |
29-
| `forward` | `(input: string): Promise<{ [category: string]: number }>` | Executes the model's forward pass, where `input` can be a fetchable resource or a Base64-encoded string. |
30-
| `onDownloadProgress` | `(callback: (downloadProgress: number) => void): any` | Subscribe to the download progress event. |
28+
| Method | Type | Description |
29+
| --------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
30+
| `load` | `(modelSource: ResourceSource, onDownloadProgressCallback: (_: number) => void () => {}): Promise<void>` | Loads the model, where `modelSource` is a string that specifies the location of the model binary. To track the download progress, supply a callback function `onDownloadProgressCallback`. |
31+
| `forward` | `(input: string): Promise<{ [category: string]: number }>` | Executes the model's forward pass, where `input` can be a fetchable resource or a Base64-encoded string. |
32+
| `delete` | `(): void` | Release the memory held by the module. Calling `forward` afterwards is invalid. |
3133

3234
<details>
3335
<summary>Type definitions</summary>
@@ -40,8 +42,12 @@ type ResourceSource = string | number | object;
4042

4143
## Loading the model
4244

43-
To load the model, use the `load` method. It accepts the `modelSource` which is a string that specifies the location of the model binary. For more information, take a look at [loading models](../fundamentals/loading-models.md) page. This method returns a promise, which can resolve to an error or void.
45+
To load the model, create a new instance of the module and use the `load` method on it. It accepts the `modelSource` which is a string that specifies the location of the model binary. For more information, take a look at [loading models](../fundamentals/loading-models.md) page. This method returns a promise, which can resolve to an error or void.
4446

4547
## Running the model
4648

47-
To run the model, you can use the `forward` method. It accepts one argument, which is the image. The image can be a remote URL, a local file URI, or a base64-encoded image. The method returns a promise, which can resolve either to an error or an object containing categories with their probabilities.
49+
To run the model, you can use the `forward` method on the module object. It accepts one argument, which is the image. The image can be a remote URL, a local file URI, or a base64-encoded image. The method returns a promise, which can resolve either to an error or an object containing categories with their probabilities.
50+
51+
## Managing memory
52+
53+
The module is a regular JavaScript object, and as such its lifespan will be managed by the garbage collector. In most cases this should be enough, and you should not worry about freeing the memory of the module yourself, but in some cases you may want to release the memory occupied by the module before the garbage collector steps in. In this case use the method `delete()` on the module object you will no longer use, and want to remove from the memory. Note that you cannot use `forward` after `delete` unless you load the module again.

0 commit comments

Comments
 (0)