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
description: "Learn how to instantly get started with the Hypermode Commerce template"
4
4
---
5
5
6
-
This guide walks you through getting started instantly with Hypermode using the [Instant Vector Search template](https://github.com/hypermodeinc/hyper-commerce). You’ll also learn how to customize your functions to tailor the app to your needs.
6
+
This guide walks you through getting started with Hypermode using the [Instant Vector Search template](https://github.com/hypermodeinc/hyper-commerce). You’ll also learn how to customize your functions to tailor the app to your needs.
Copy file name to clipboardExpand all lines: introduction.mdx
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,9 @@ mode: "wide"
9
9
deployment, API, hosting, storage "everything you need to run your AI APIs")
10
10
</Warning>
11
11
12
-
Hypermode is a platform for building and hosting AI features and assistants for your applications. It aims to include or integrate with everything you need to ship real-time APIs that combine AI and your application logic. We've created an open source framework to make that even easier: [Modus](github.com/hypermodeinc/modus).
12
+
Hypermode is a platform for building and hosting AI features and assistants for your applications. It aims to include or integrate with everything you need to ship real-time APIs that combine AI and your application logic.
13
+
14
+
We've created an open source framework to make that even easier: [Modus](github.com/hypermodeinc/modus).
13
15
14
16
The Hypermode API is organized around [GraphQL](https://graphql.org/learn/). Our platform automatically generates a managed GraphQL endpoint for the functions you write. Hypermode can securely connect to models via HTTPS as well as host models for you.
Copy file name to clipboardExpand all lines: modus/overview.mdx
+53-50Lines changed: 53 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,58 +8,61 @@ mode: "wide"
8
8
- overview of the framework - use cases and benefits for developers
9
9
</Warning>
10
10
11
-
The SDK provides:
11
+
**An open-source framework to make intelligent APIs real-time, incrementally adoptable, and universal.**
12
12
13
-
- A project structure to organize your functions
14
-
- A set of APIs to interact with data, AI models, and other services
15
-
- A local development environment to download dependencies and compile your functions
16
-
- A CI/CD workflow that automatically deploys your functions on Hypermode when pushing changes to your repository
13
+
## Quick install
14
+
15
+
16
+
```bash
17
+
brew install modus
18
+
```
19
+
20
+
21
+
## What is this?
22
+
Modus is an open-source, serverless framework for building functions and APIs, powered by WebAssembly. This framework is aimed at assisting in the development of the next generation of APIs and services.
23
+
24
+
To build the applications and services we want-- applications that are thoughtful, fun, and effective.
25
+
26
+
We often need to integrate models (Large Languages Models, Machine Learning Models, Deep Learning Models, etc.) with our application code.
27
+
28
+
These applications can be simple CRUD (Create, Read, Update, and Delete) applications that have a simple model that resolves duplicates, or then can be complex agentic reasoning applications that chain together dozens of models and data sources.
29
+
30
+
*Standing up services that arrange data, models, and logic into useful chains of inputs, outputs, and loops shouldn’t be difficult.*
31
+
32
+
Modus exists to make it easier for you to build the applications of your dreams.
33
+
34
+
## What can I do with it?
35
+
Modus is designed primarily as a general-purpose application framework, it just happens to treat models as a first-class component. With Modus you can use models, as appropriate, without additional complexity.
36
+
37
+
However, Modus is best for applications that require sub-second response times. We've made trade-offs to optimize for speed and simplicity.
38
+
39
+
### Common use cases include:
40
+
-**Search Engines**: instead of using keyword search or basic filters, you can use cost-effective models to understand the user's intent and return the most relevant results.
41
+
-**Recommendation Engines**: instead of using pre-computed recommendations or collaborative filtering, you can use models to understand the user's preferences and return the most relevant recommendations or combine classical and generative AI methods into a superior recommendation engine.
42
+
-**Spam/Fraud Detection**: instead of using simple rules or blacklists, you can generate embeddings of user generated content and compare it to known spam. This makes it much more difficult for bad actors to circumvent your filters. If you don't have any labeled data to start, you can use a larger model to classify "spam, not spam" until you fine tune a smaller, less expensive model.
43
+
-**Agents**: chain together models and data sources to create agents that can reason about the world and take actions on your behalf.
44
+
45
+
## How is it organized?
46
+
47
+
### It aims to create:
48
+
1. Strong defaults with infinite customization for managing data, logic, and models that reduce the complexity required to work with non-deterministic systems ("AI").
49
+
2. Deployment patterns that facilitate sub-second intelligence within user-facing applications.
50
+
3. A toolkit that allows teams to incrementally adopt models within their existing applications.
51
+
4. A multi-language framework with a lightweight footprint that makes AI usable for developers with varied needs and sophistication.
52
+
53
+
### Modus provides:
54
+
- A project structure to organize your functions.
55
+
- A set of APIs to interact with data, AI models, and other services.
56
+
- A local development environment to download dependencies and compile your functions.
57
+
- A CI/CD workflow that automatically deploys your functions on [Hypermode](hypermode.com/new) when pushing changes to your repository.
17
58
18
59
<Note>
19
-
The Functions SDK currently includes support for AssemblyScript, a
20
-
TypeScript-like language. Additional language support is in development.
60
+
Modus is a multi-language framework. It currently includes support for GoLang and AssemblyScript, a WebAssembly compatible TypeScript-like language. Additional language support is in development.
21
61
</Note>
22
62
23
-
The SDK is available at [https://github.com/hypermodeinc/functions-as](https://github.com/hypermodeinc/functions-as).
24
-
25
-
For inspiration on getting started, reference the [examples in the SDK repository](https://github.com/hypermodeinc/functions-as/tree/main/examples).
26
-
27
-
## APIs
28
-
29
-
The following APIs are available in the Functions SDK:
30
-
31
-
<Tip>
32
-
We're constantly introducing new APIs through ongoing development with build
33
-
partners. [Let's chat](mailto:[email protected]) about what would make the
34
-
Functions SDK even more powerful for your next use case!
The easiest way to start with Hypermode is using the [template project](https://github.com/hypermodeinc/base-template).
63
+
### Where do I write my code?
64
+
65
+
We organize your application into 2 primary components:
66
+
67
+
-`modus.json` we call this your [Manifest](https://hypermode-modus-docs.mintlify.app/modus/app-manifest). Where you decide what models, data, and external services you’d like your functions to have access to.
68
+
-`/functions/` is where you put your function code. If you're writing in AssemblyScript, you'll publish your functions in the `/assembly/index.ts` file. For Golang, simply capitalizing a function's name will expose it in the Modus API.
0 commit comments