You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/01-fundamentals/01-getting-started.md
+28-1Lines changed: 28 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,32 +38,59 @@ For supported React Native and Expo versions, see the [Compatibility table](../0
38
38
39
39
## Installation
40
40
41
-
Installation is pretty straightforward, just use your favorite package manager.
41
+
Installation is pretty straightforward, use your package manager of choice to install the package and some peer dependencies required to streamline model downloads. If you want to implement your custom model fetching logic, see [this document]().
Calling any library API without initializing first will throw a `ResourceFetcherAdapterNotInitialized` error.
92
+
:::
93
+
67
94
Our library offers support for both bare React Native and Expo projects. Please follow the instructions from [Loading models section](./02-loading-models.md) to make sure you setup your project correctly. We encourage you to use Expo project if possible. If you are planning to migrate from bare React Native to Expo project, the link (https://docs.expo.dev/bare/installing-expo-modules/) offers a guidance on setting up Expo Modules in a bare React Native environment.
68
95
69
96
If you plan on using your models via require() instead of fetching them from a url, you also need to add following lines to your `metro.config.js`:
Copy file name to clipboardExpand all lines: packages/react-native-executorch/src/utils/ResourceFetcher.ts
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -106,7 +106,7 @@ export class ResourceFetcher {
106
106
staticgetAdapter(): ResourceFetcherAdapter{
107
107
if(!this.adapter){
108
108
consterrorMessage=
109
-
'ResourceFetcher adapter is not initialized. Please call initExecutorch({ resourceFetcher: ... }) with a valid adapter, e.g., from react-native-executorch-expo-resource-fetcher or react-native-executorch-bare-resource-fetcher. For more details please refer: https://docs.swmansion.com/react-native-executorch/docs/next/fundamentals/loading-models';
109
+
'ResourceFetcher adapter is not initialized. Please call initExecutorch({ resourceFetcher: ... }) with a valid adapter, e.g., from react-native-executorch-expo-resource-fetcher or react-native-executorch-bare-resource-fetcher. For more details please refer to: https://docs.swmansion.com/react-native-executorch/docs/next/fundamentals/loading-models';
0 commit comments