Skip to content

Commit 668f375

Browse files
fix: docs typo (#67)
## Description <!-- Provide a concise and descriptive summary of the changes implemented in this PR. --> ### 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) - [ ] Documentation update (improves or adds clarity to existing documentation) ### 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. -->
1 parent fd8dc38 commit 668f375

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/docs/module-api/executorch-bindings.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ The `modelSource` parameter expects a location string pointing to the model bina
2929

3030
### Returns
3131

32-
| Field | Type | Description |
33-
| ------------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34-
| `error` | <code>string &#124; null</code> | Contains the error message if the model failed to load. |
32+
| Field | Type | Description |
33+
| -------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34+
| `error` | <code>string &#124; null</code> | Contains the error message if the model failed to load. |
3535
| `isGenerating` | `boolean` | Indicates whether the model is currently processing an inference. |
3636
| `isReady` | `boolean` | Indicates whether the model has successfully loaded and is ready for inference. |
37-
| `loadMethod` | `(methodName: string) => Promise<void>` | Loads resources specific to `methodName` into memory before execution. |
38-
| `loadForward` | `() => Promise<void>` | Loads resources specific to `forward` method into memory before execution. Uses `loadMethod` under the hood. |
39-
| `forward` | `(input: ETInput, shape: number[]) => Promise<number[][]>` | Executes the model's forward pass, where `input` is a Javascript typed array and `shape` is an array of integers representing input Tensor shape. The output is a Tensor - raw result of inference. |
37+
| `loadMethod` | `(methodName: string) => Promise<void>` | Loads resources specific to `methodName` into memory before execution. |
38+
| `loadForward` | `() => Promise<void>` | Loads resources specific to `forward` method into memory before execution. Uses `loadMethod` under the hood. |
39+
| `forward` | `(input: ETInput, shape: number[]) => Promise<number[][]>` | Executes the model's forward pass, where `input` is a Javascript typed array and `shape` is an array of integers representing input Tensor shape. The output is a Tensor - raw result of inference. |
4040

4141
### ETInput
4242

@@ -58,7 +58,7 @@ To run model with ExecuTorch Bindings it's essential to specify the shape of the
5858

5959
## End to end example
6060

61-
This example demonstrates the integration and usage of the ExecuTorch bindings with a [style transfer model](../computer-vision/useStyleTransfer.md). Specifically, we'll be using the `STYLE_TRANSFER_CANDY` model, which applies artistic style transfer to an input image.
61+
This example demonstrates the integration and usage of the ExecuTorch bindings with a [style transfer model](../computer-vision/useStyleTransfer.mdx). Specifically, we'll be using the `STYLE_TRANSFER_CANDY` model, which applies artistic style transfer to an input image.
6262

6363
### Importing the Module and loading the model
6464

0 commit comments

Comments
 (0)