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.

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

Draft getting-started.md #143

Merged
merged 3 commits into from
Jul 14, 2023
Merged
Changes from 1 commit
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
49 changes: 49 additions & 0 deletions docs/imgs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Getting Started

## Description

This is a quick guide to get LeapFrogAI running locally.

## Requirements

* Go >= 1.20
* Python >= 3.10
* Cuda >= 11.8
* NVidia GPU w/ 16GB VRAM (24GB recommended)

## Instructions

### API Server

LeapFrogAI's API server is written in go. To launch the API Server:

``` shell
go run ./api/main.go
```

### mpt-7b-chat

1. Navigate to `./models/llms/mpt-7b-chat`.
2. Create a venv and activate it:

``` shell
python3 -m venv venv

source ./venv/bin/activate
```

3. Pull the model (this will take some time):

``` shell
python get_model.py
```

4. Launch the model server:

``` shell
python model.py
```

The URL for this server will default to http://localhost:8080/openai.

^ If you need a client, check this out: https://github.com/defenseunicorns/chatbot-ui
Loading