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 .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CODEOWNERS info: https://help.github.com/en/articles/about-code-owners
# Owners are automatically requested for review for PRs that changes code
# that they own.
* @hypermodeAI/docs
* @hypermodeinc/docs
12 changes: 6 additions & 6 deletions getting-started-with-hyper-commerce.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ title: "Quickstart: Hyper Commerce"
description: "Learn how to instantly get started with the Hypermode Commerce template"
---

This guide walks you through getting started instantly with Hypermode using the [Instant Vector Search template](https://github.com/hypermodeAI/hyper-commerce). You’ll also learn how to customize your functions to tailor the app to your needs.
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.

## What's Hypermode?

[Hypermode](/introduction) is framework designed to simplify the development and deployment of AI features and assistants. With its [Functions SDK](/sdk/functions-sdk) and runtime, developers can quickly deploy intelligent features into production without the need for extensive data wrangling. Hypermode supports rapid iteration, allowing you to start with a large language model and later fine-tune smaller, open source models. Its production-ready GraphQL API auto-generates and enables seamless integration. Hypermode is ideal for developers looking to quickly prototype and evolve AI capabilities.

## Quickstart

You can get started with Hypermode’s [Instant Vector Search](https://github.com/hypermodeAI/hyper-commerce) template using either sample data or your own, without needing to write any code or set up a GitHub repository. This lets you explore the template and Hypermode’s features before committing any time and effort.
You can get started with Hypermode’s [Instant Vector Search](https://github.com/hypermodeinc/hyper-commerce) template using either sample data or your own, without needing to write any code or set up a GitHub repository. This lets you explore the template and Hypermode’s features before committing any time and effort.

### Step 1: Creating a new project

Expand Down Expand Up @@ -48,7 +48,7 @@ You can get started with Hypermode’s [Instant Vector Search](https://github.co

> If you choose to use your own data, you'll need to upload it using a CSV file and a Python script provided in Step 2.

5. Once created, Hypermode provisions a runtime with instant connectivity to shared AI models that bring the functions within your project to life. The source code for the project is open source, available in [this repository](https://github.com/hypermodeAI/hyper-commerce).
5. Once created, Hypermode provisions a runtime with instant connectivity to shared AI models that bring the functions within your project to life. The source code for the project is open source, available in [this repository](https://github.com/hypermodeinc/hyper-commerce).

Behind the scenes, Hypermode automatically exposes the functions from the backend directory as GraphQL APIs, allowing you to interact with them like any other GraphQL endpoint.

Expand All @@ -58,7 +58,7 @@ If you selected sample data, your project is fully setup. You can move on to Ste

1. Ensure you have [Python](https://www.python.org/downloads/) installed on your machine. You can verify this by running `python --version` or `python3 --version` in your terminal.
2. Prepare your CSV file with the following headers: `Unique Id,Product Name,Category,Selling Price,About Product,Image,Num Stars,In Stock`.
3. Copy the script from [this file](https://www.notion.so/Getting-Started-with-Hypermode-1fba345ba60c4ecbade5663a2251eedc?pvs=21).
3. Copy the script from [this file](https://github.com/hypermodeinc/hyper-commerce/blob/main/backend/extras/ecommerce_populate.py).
4. Update the script with your endpoint (located in your projects dashboard), API key (located in the settings tab of your Hypermode console), and the path to your CSV file.
5. Install the necessary dependencies:

Expand Down Expand Up @@ -127,7 +127,7 @@ Now that you set up, deployed, and seeded your project with data, you can test y

Now that you've set up your project and queried your data in the console, you can test the capability in a frontend UI.

1. Clone the repository that contains a pre-built UI for testing. You can find the repo [here](https://github.com/hypermodeAI/hyper-commerce/tree/main/frontend).
1. Clone the repository that contains a pre-built UI for testing. You can find the repo [here](https://github.com/hypermodeinc/hyper-commerce/tree/main/frontend).
2. Retrieve your API key from the Settings section of your Hypermode console.
3. Create a `.env.local` file in the root of your project and add your API key and endpoint to it, like this:

Expand All @@ -154,7 +154,7 @@ In this section, you’ll learn how to tailor the template to fit your specific

### Step 1: Clone the template repository

1. Go to the template repo [hyper-commerce](https://github.com/hypermodeAI/hyper-commerce).
1. Go to the template repo [hyper-commerce](https://github.com/hypermodeinc/hyper-commerce).
2. Clone the repo by clicking `Use this template` in the upper-right corner and selecting `Create new repo.` This clones the code into your own GitHub repository
3. Visit the [Hypermode website](https://hypermode.com/sign-in) and sign up with your GitHub, Google, or email address. Once signed in, you'll see your Hypermode projects dashboard.
4. In the Hypermode console, click `New Project`.
Expand Down
2 changes: 1 addition & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
],
"footerSocials": {
"discord": "https://discord.hypermode.com",
"github": "https://github.com/hypermodeAI",
"github": "https://github.com/hypermodeinc",
"twitter": "https://twitter.com/hypermodeAI",
"linkedin": "https://www.linkedin.com/company/hypermode"
},
Expand Down
4 changes: 2 additions & 2 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ mode: "wide"

<Steps>
<Step title="Clone the Base Template">
Use the [template](https://github.com/hypermodeAI/base-template) to set up your Hypermode project.
Use the [template](https://github.com/hypermodeinc/base-template) to set up your Hypermode project.
</Step>
<Step title="Set Up Your Manifest">
Define your [AI models](/define-models) in your [project manifest](/manifest). You'll reference these model definitions in your functions.
Expand All @@ -24,5 +24,5 @@ mode: "wide"

<Tip>
For inspiration on getting started, reference the [examples in the Function
SDK repo](https://github.com/hypermodeAI/functions-as/tree/main/examples).
SDK repo](https://github.com/hypermodeinc/functions-as/tree/main/examples).
</Tip>
2 changes: 1 addition & 1 deletion sdk/collections.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ in your project's manifest, you can use the following APIs to interact with the
## Example project

For your reference, A complete example for using the Collections APIs is available on GitHub in the
`hypermodeAI/functions-as` repository, at [/examples/collection](https://github.com/hypermodeAI/functions-as/tree/main/examples/collection).
`hypermodeinc/functions-as` repository, at [/examples/collection](https://github.com/hypermodeinc/functions-as/tree/main/examples/collection).

## Import from the SDK

Expand Down
2 changes: 1 addition & 1 deletion sdk/console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ object, but directs the output to Hypermode as follows:
## Example project

For your reference, an example that uses the Console APIs is available on GitHub in the
`hypermodeAI/functions-as` repository, at [/examples/simple](https://github.com/hypermodeAI/functions-as/tree/main/examples/simple).
`hypermodeinc/functions-as` repository, at [/examples/simple](https://github.com/hypermodeinc/functions-as/tree/main/examples/simple).

You'll also find the Console APIs used throughout other examples in the repository.

Expand Down
2 changes: 1 addition & 1 deletion sdk/dgraph.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ you can use the following APIs to interact with the database.
## Example project

For your reference, a complete example using the Dgraph APIs is available on GitHub in the
`hypermodeAI/functions-as` repository, at [/examples/dgraph](https://github.com/hypermodeAI/functions-as/tree/main/examples/dgraph).
`hypermodeinc/functions-as` repository, at [/examples/dgraph](https://github.com/hypermodeinc/functions-as/tree/main/examples/dgraph).

## Import from the SDK

Expand Down
6 changes: 3 additions & 3 deletions sdk/functions-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ The SDK provides:
TypeScript-like language. Additional language support is in development.
</Note>

The SDK is available at [https://github.com/hypermodeAI/functions-as](https://github.com/hypermodeAI/functions-as).
The SDK is available at [https://github.com/hypermodeinc/functions-as](https://github.com/hypermodeinc/functions-as).

For inspiration on getting started, reference the [examples in the SDK repository](https://github.com/hypermodeAI/functions-as/tree/main/examples).
For inspiration on getting started, reference the [examples in the SDK repository](https://github.com/hypermodeinc/functions-as/tree/main/examples).

## APIs

Expand Down Expand Up @@ -59,4 +59,4 @@ The following APIs are available in the Functions SDK:

## Installation

The easiest way to start with Hypermode is using the [template project](https://github.com/hypermodeAI/base-template).
The easiest way to start with Hypermode is using the [template project](https://github.com/hypermodeinc/base-template).
2 changes: 1 addition & 1 deletion sdk/graphql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ you can use the following APIs to interact with the data.
## Example project

For your reference, A complete example for using the GraphQL APIs is available on GitHub in the
`hypermodeAI/functions-as` repository, at [/examples/graphql](https://github.com/hypermodeAI/functions-as/tree/main/examples/graphql).
`hypermodeinc/functions-as` repository, at [/examples/graphql](https://github.com/hypermodeinc/functions-as/tree/main/examples/graphql).

## Import from the SDK

Expand Down
2 changes: 1 addition & 1 deletion sdk/http.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ committed to your repository, and aren't visible or accessible from your functio
## Example project

For your reference, A complete example for using the HTTP API is available on GitHub in the
`hypermodeAI/functions-as` repository, at [/examples/http](https://github.com/hypermodeAI/functions-as/tree/main/examples/http).
`hypermodeinc/functions-as` repository, at [/examples/http](https://github.com/hypermodeinc/functions-as/tree/main/examples/http).

## Import from the SDK

Expand Down
14 changes: 7 additions & 7 deletions sdk/models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ Since many models have unique interfaces, the design of the Models API is extrem
flexible. A common base class forms the core of the API, which extends to conform to
any model's required schema.

A separate library, [`models-as`](https://github.com/hypermodeAI/models-as) contains
A separate library, [`models-as`](https://github.com/hypermodeinc/models-as) contains
both the base classes and pre-defined implementations for many commonly used models.
You can either use one of the pre-defined classes, or can create custom classes for
any model you like, by extending from the base `Model` class.

## Example project

For your reference, several complete examples for using the Models API are available
on GitHub in the `hypermodeAI/functions-as` repository:
on GitHub in the `hypermodeinc/functions-as` repository:

- [/examples/classification](https://github.com/hypermodeAI/functions-as/tree/main/examples/classification)
- [/examples/embedding](https://github.com/hypermodeAI/functions-as/tree/main/examples/embedding)
- [/examples/textgeneration](https://github.com/hypermodeAI/functions-as/tree/main/examples/textgeneration)
- [/examples/classification](https://github.com/hypermodeinc/functions-as/tree/main/examples/classification)
- [/examples/embedding](https://github.com/hypermodeinc/functions-as/tree/main/examples/embedding)
- [/examples/textgeneration](https://github.com/hypermodeinc/functions-as/tree/main/examples/textgeneration)

Each example demonstrates using different types of AI models for different purposes.
However, the Models interface isn't limited to these purposes. You can use it for any
Expand Down Expand Up @@ -59,11 +59,11 @@ For example:
import { ClassificationModel } from "@hypermode/models-as/models/experimental/classification";
```

Refer to the [`hypermodeAI/models-as`](https://github.com/hypermodeAI/models-as/tree/main/src/models)
Refer to the [`hypermodeinc/models-as`](https://github.com/hypermodeinc/models-as/tree/main/src/models)
repository for the full list of available models. We're constantly adding new models, so the
list may have grown since you last checked.

If you would like to request a new model, please [open an issue](https://github.com/hypermodeAI/models-as/issues)
If you would like to request a new model, please [open an issue](https://github.com/hypermodeinc/models-as/issues)
on the `models-as` repository. You can also send a pull request, if you'd like to contribute a new model yourself.

</CodeGroup>
Expand Down
2 changes: 1 addition & 1 deletion sdk/postgresql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ you can use the following APIs to interact with the data.
## Example project

For your reference, A complete example for using the GraphQL APIs is available on GitHub in the
`hypermodeAI/functions-as` repository, at [/examples/postgresql](https://github.com/hypermodeAI/functions-as/tree/main/examples/postgresql).
`hypermodeinc/functions-as` repository, at [/examples/postgresql](https://github.com/hypermodeinc/functions-as/tree/main/examples/postgresql).

## Import from the SDK

Expand Down