Skip to content

Commit 2d12838

Browse files
p3t3rzbNorbertKlockiewicz
p3t3rzb
and
NorbertKlockiewicz
authored
docs: fixed docs useImageSegmentation (#520)
## Description <!-- Provide a concise and descriptive summary of the changes implemented in this PR. --> ### Introduces a breaking change? - [ ] Yes - [ ] No ### Type of change - [ ] Bug fix (change which fixes an issue) - [ ] New feature (change which adds functionality) - [ ] Documentation update (improves or adds clarity to existing documentation) - [ ] Other (chores, tests, code style improvements etc.) ### Tested on - [ ] iOS - [ ] Android ### Testing instructions <!-- Provide step-by-step instructions on how to test your changes. Include setup details if necessary. --> ### Screenshots <!-- Add screenshots here, if applicable --> ### Related issues <!-- Link related issues here using #issue-number --> ### Checklist - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have updated the documentation accordingly - [ ] My changes generate no new warnings ### Additional notes <!-- Include any additional information, assumptions, or context that reviewers might need to understand this PR. --> --------- Co-authored-by: Norbert Klockiewicz <Nklockiewicz12@gmail.com>
1 parent 5a136dd commit 2d12838

10 files changed

Lines changed: 58 additions & 58 deletions

File tree

‎docs/docs/02-hooks/02-computer-vision/useClassification.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ For more information on loading resources, take a look at [loading models](../..
4040

4141
### Returns
4242

43-
| Field | Type | Description |
44-
| ------------------ | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |
45-
| `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. |
46-
| `error` | <code>string &#124; null</code> | Contains the error message if the model failed to load. |
47-
| `isGenerating` | `boolean` | Indicates whether the model is currently processing an inference. |
48-
| `isReady` | `boolean` | Indicates whether the model has successfully loaded and is ready for inference. |
49-
| `downloadProgress` | `number` | Represents the download progress as a value between 0 and 1. |
43+
| Field | Type | Description |
44+
| ------------------ | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
45+
| `forward` | `(imageSource: string) => Promise<{ [category: string]: number }>` | Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string. |
46+
| `error` | <code>string &#124; null</code> | Contains the error message if the model failed to load. |
47+
| `isGenerating` | `boolean` | Indicates whether the model is currently processing an inference. |
48+
| `isReady` | `boolean` | Indicates whether the model has successfully loaded and is ready for inference. |
49+
| `downloadProgress` | `number` | Represents the download progress as a value between 0 and 1. |
5050

5151
## Running the model
5252

@@ -84,8 +84,8 @@ function App() {
8484

8585
## Supported models
8686

87-
| Model | Number of classes | Class list |
88-
| --------------------------------------------------------------------------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
87+
| Model | Number of classes | Class list |
88+
| ----------------------------------------------------------------------------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8989
| [efficientnet_v2_s](https://pytorch.org/vision/stable/models/generated/torchvision.models.efficientnet_v2_s.html) | 1000 | [ImageNet1k_v1](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/common/rnexecutorch/models/classification/Constants.h) |
9090

9191
## Benchmarks

‎docs/docs/02-hooks/02-computer-vision/useImageEmbeddings.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ For more information on loading resources, take a look at [loading models](../..
5151

5252
### Returns
5353

54-
| Field | Type | Description |
55-
| ------------------ | ----------------------------------------------- | --------------------------------------------------------------------------------------------- |
56-
| `forward` | `(input: imageSource) => Promise<Float32Array>` | Executes the model's forward pass, where `input` is a URI/URL to image that will be embedded. |
57-
| `error` | <code>string &#124; null</code> | Contains the error message if the model failed to load. |
58-
| `isGenerating` | `boolean` | Indicates whether the model is currently processing an inference. |
59-
| `isReady` | `boolean` | Indicates whether the model has successfully loaded and is ready for inference. |
60-
| `downloadProgress` | `number` | Represents the download progress as a value between 0 and 1. |
54+
| Field | Type | Description |
55+
| ------------------ | ------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
56+
| `forward` | `(imageSource: string) => Promise<Float32Array>` | Executes the model's forward pass, where `imageSource` is a URI/URL to image that will be embedded. |
57+
| `error` | <code>string &#124; null</code> | Contains the error message if the model failed to load. |
58+
| `isGenerating` | `boolean` | Indicates whether the model is currently processing an inference. |
59+
| `isReady` | `boolean` | Indicates whether the model has successfully loaded and is ready for inference. |
60+
| `downloadProgress` | `number` | Represents the download progress as a value between 0 and 1. |
6161

6262
## Running the model
6363

0 commit comments

Comments
 (0)