Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/benchmarks/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Benchmarks",
"position": 5,
"position": 7,
"link": {
"type": "generated-index"
}
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/computer-vision/useObjectDetection.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: useObjectDetection
sidebar_position: 2
sidebar_position: 3
---

Object detection is a computer vision technique that identifies and locates objects within images or video. It’s commonly used in applications like image recognition, video surveillance or autonomous driving.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/computer-vision/useStyleTransfer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: useStyleTransfer
sidebar_position: 3
sidebar_position: 2
---

Style transfer is a technique used in computer graphics and machine learning where the visual style of one image is applied to the content of another. This is achieved using algorithms that manipulate data from both images, typically with the aid of a neural network. The result is a new image that combines the artistic elements of one picture with the structural details of another, effectively merging art with traditional imagery. React Native ExecuTorch offers a dedicated hook `useStyleTransfer`, for this task. However before you start you'll need to obtain ExecuTorch-compatible model binary.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hookless-api/ExecutorchModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: ExecuTorchModule
sidebar_position: 5
sidebar_position: 2
---

Hookless implementation of the [useExecutorchModule](../module-api/executorch-bindings.md) hook.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hookless-api/LLMModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: LLMModule
sidebar_position: 4
sidebar_position: 3
---

Hookless implementation of the [useLLM](../llms/running-llms.md) hook.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hookless-api/ObjectDetectionModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: ObjectDetectionModule
sidebar_position: 2
sidebar_position: 5
---

Hookless implementation of the [useObjectDetection](../computer-vision/useObjectDetection.mdx) hook.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hookless-api/StyleTransferModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: StyleTransferModule
sidebar_position: 3
sidebar_position: 4
---

Hookless implementation of the [useStyleTransfer](../computer-vision/useStyleTransfer.mdx) hook.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hookless-api/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Hookless API",
"position": 5,
"position": 4,
"link": {
"type": "generated-index"
}
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/module-api/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Module API",
"position": 4,
"position": 5,
"link": {
"type": "generated-index"
}
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/utils/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Utils",
"position": 6,
"link": {
"type": "generated-index"
}
}
43 changes: 43 additions & 0 deletions docs/docs/utils/list-downloaded-resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: List Downloaded Resources
sidebar_position: 1
---

This module provides functions to retrieve a list of downloaded files stored in the application's document directory inside the `react-native-executorch/` directory. These utilities can help you manage your storage and clean up the downloaded files when they are no longer needed.

## listDownloadedFiles

Lists all the downloaded files used by React Native ExecuTorch.

### Reference

```typescript
import { listDownloadedFiles } from 'react-native-executorch';

const filesUris = await listDownloadedFiles();
```

### Returns

`Promise<string[]>` - A promise, which resolves to an array of URIs for all the downloaded files.

:::info
Since this function returns all the downloaded files, it also includes all the downloaded models.
If you want to list only the downloaded models, use the [listDownloadedModels](./list-downloaded-resources.md#listdownloadedmodels) function.
:::

## listDownloadedModels

Lists all the downloaded models used by React Native ExecuTorch.

### Reference

```typescript
import { listDownloadedModels } from 'react-native-executorch';

const modelsUris = await listDownloadedModels();
```

### Returns

`Promise<string[]>` - A promise, which resolves to an array of URIs for all the downloaded models.