Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modus Quickstart updates #79

Merged
merged 2 commits into from
Dec 24, 2024
Merged

Modus Quickstart updates #79

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79109ce
modus quickstart updates
jacklynlee31 Dec 20, 2024
00e5024
small change
jacklynlee31 Dec 20, 2024
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
28 changes: 27 additions & 1 deletion modus/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ learn how to use the basic components of a Modus app and how to run it locally.
View endpoint: http://localhost:8686/explorer
```

This interface allows you to interact with your app's API and test your functions.
The API Explorer interface allows you to interact with your app's API and test your functions.

<img
className="block"
Expand Down Expand Up @@ -172,6 +172,32 @@ learn how to use the basic components of a Modus app and how to run it locally.

</Tab>
</Tabs>
After adding your function, you can use the API Explorer interface to test the `GetRandomQuote` function.

</Step>
<Step title="Add a model">
Modus also supports AI models. You can define new models in your `modus.json` file. Let's add a new meta-llama model:

```json
"models": {
"text-generator": {
"sourceModel": "meta-llama/Meta-Llama-3.1-8B-Instruct",
"provider": "hugging-face",
"connection": "hypermode"
}
},
```

</Step>
<Step title="Install the Hyp CLI and log in">
Next, install the Hyp CLI. This allows you to access hosted models on the Hypermode platform.

```bash
npm install -g @hypermode/hyp-cli
```

You can now use the `hyp login` command to log in to the Hyp CLI.
This links your project to the Hypermode platform, allowing you to leverage the model in your modus app.

</Step>
</Steps>
Loading