Skip to content

Commit

Permalink
Add emojis to headlines in README
Browse files Browse the repository at this point in the history
  • Loading branch information
homanp committed Mar 1, 2024
1 parent 40a3807 commit 5f30a80
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@
</div>


## Key features
## Key features
- Supports multiple document formats and vector databases.
- Provides a production ready REST API.
- Includes options for encoding data using different encoding models both propriatory and open source.
- Built in code interpreter mode for computational question & answer scenarios.
- Allows session management through unique IDs for caching purposes.

## Cloud API
## ☁️ Cloud API

Easiset way to get started is to use our [Cloud API](https://d3jvqvcd9u4534.cloudfront.net). This API is free to use (within reasonable limits).

## Installation
## 📦 Installation

1. Clone the repository
```bash
Expand Down Expand Up @@ -56,7 +56,7 @@ Easiset way to get started is to use our [Cloud API](https://d3jvqvcd9u4534.clou
uvicorn main:app --reload
```

## How to use
## 🚀 How to use
Super-Rag comes with a built in REST API powered by FastApi.

### Ingest documents
Expand Down Expand Up @@ -130,14 +130,14 @@ Super-Rag comes with a built in REST API powered by FastApi.
```

## Supportd encoders
## 🧠 Supportd encoders
- OpenAi
- Cohere
- HuggingFace
- FastEmbed


## Supported vector databases
## 🗃 Supported vector databases
- Weaviate
- Qdrant
- Weaviate
Expand Down

0 comments on commit 5f30a80

Please sign in to comment.