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
14 changes: 14 additions & 0 deletions docs/docs/fundamentals/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
---
title: Getting Started
sidebar_position: 1
keywords:
[
react native,
executorch,
ai,
machine learning,
on-device,
pytorch,
mobile ai,
getting started,
installation,
llm,
]
description: 'Get started with React Native ExecuTorch - a framework for running AI models on-device in your React Native applications.'
---

import Tabs from '@theme/Tabs';
Expand Down
16 changes: 16 additions & 0 deletions docs/docs/llms/useLLM.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
---
title: useLLM
sidebar_position: 1
keywords:
[
llm,
large language model,
llama,
llama 3,
react native,
executorch,
ai,
machine learning,
on-device,
mobile ai,
inference,
text generation,
]
description: "Learn how to use Llama models in your React Native applications with React Native ExecuTorch's useLLM hook."
---

React Native ExecuTorch supports Llama 3.2 models, including quantized versions. Before getting started, you’ll need to obtain the .pte binary—a serialized model—and the tokenizer. There are various ways to accomplish this:
Expand Down
16 changes: 16 additions & 0 deletions docs/docs/speech-to-text/useSpeechToText.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
---
title: useSpeechToText
sidebar_position: 1
keywords:
[
speech to text,
stt,
voice recognition,
transcription,
whisper,
moonshine,
react native,
executorch,
ai,
machine learning,
on-device,
mobile ai,
]
description: "Learn how to use speech-to-text models in your React Native applications with React Native ExecuTorch's useSpeechToText hook."
---

With the latest `v0.3.0` release we introduce a new hook - `useSpeechToText`. Speech to text is a task that allows to transform spoken language to written text. It is commonly used to implement features such as transcription or voice assistants. As of now, [all supported STT models](#supported-models) run on the XNNPACK backend.
Expand Down
8 changes: 8 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ const darkCodeTheme = require('./src/theme/CodeBlock/highlighting-dark.js');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'React Native ExecuTorch',
tagline:
'Declarative way to run AI models in React Native on device, powered by ExecuTorch',
favicon: 'img/favicon.ico',

url: 'https://docs.swmansion.com',
Expand Down Expand Up @@ -35,6 +37,12 @@ const config = {
trackingID: 'G-TJND8QJM9P',
anonymizeIP: true,
},
sitemap: {
changefreq: 'weekly',
priority: 0.5,
ignorePatterns: ['/tags/**'],
filename: 'sitemap.xml',
},
}),
],
],
Expand Down
1 change: 1 addition & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
},
"dependencies": {
"@docusaurus/core": "2.4.3",
"@docusaurus/plugin-sitemap": "2.4.3",
"@docusaurus/preset-classic": "2.4.3",
"@mdx-js/react": "^1.6.22",
"@swmansion/t-rex-ui": "^0.0.14",
Expand Down
7 changes: 7 additions & 0 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import React from 'react';
import Layout from '@theme/Layout';
import Head from '@docusaurus/Head';
import styles from './styles.module.css';
import HomepageStartScreen from '@site/src/components/Hero/StartScreen';
import WaveTop from '@site/src/components/Wave/WaveTop';
Expand All @@ -14,6 +15,12 @@ const Home = () => {
title="React Native ExecuTorch"
description="Declarative way to run AI models in React Native on device, powered by ExecuTorch."
>
<Head>
<meta
name="keywords"
content="react native, executorch, ai, machine learning, on-device, pytorch, mobile ai, react native ai, artificial intelligence, mobile machine learning, on-device inference, llama, llm, whisper, ocr, moonshine, speech to text"
/>
</Head>
<div className={styles.container}>
<HomepageStartScreen />
</div>
Expand Down
3 changes: 3 additions & 0 deletions docs/static/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
User-agent: *
Allow: /
Sitemap: https://docs.swmansion.com/react-native-executorch/sitemap.xml
1 change: 1 addition & 0 deletions docs/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -4739,6 +4739,7 @@ __metadata:
dependencies:
"@docusaurus/core": 2.4.3
"@docusaurus/module-type-aliases": 2.4.3
"@docusaurus/plugin-sitemap": 2.4.3
"@docusaurus/preset-classic": 2.4.3
"@mdx-js/react": ^1.6.22
"@swmansion/t-rex-ui": ^0.0.14
Expand Down