Skip to content

Commit f4e777a

Browse files
committed
fix(readme): improve readme structure
1 parent ac2255e commit f4e777a

File tree

1 file changed

+12
-23
lines changed

1 file changed

+12
-23
lines changed

README.md

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,50 +5,39 @@
55

66
Flare AI SDK for Consensus Learning.
77

8-
This repository provides a Python implementation of a single-node, multi-model **Consensus Learning (CL)** framework. CL is a decentralized ensemble learning approach described in [arXiv:2402.16157](https://arxiv.org/abs/2402.16157).
9-
10-
The current implementation specializes in leveraging Large Language Models (LLMs) through a centralized architecture using OpenAI's [OpenRouter](https://openrouter.ai/docs/quick-start). OpenRouter offers access to over 300 models via a unified interface.
11-
12-
This repository serves as the reference implementation for the **Consensus Learning track** at the **Verifiable AI Hackathon** organized by Google Cloud in collaboration with Flare. For more details, please visit the [main hackathon website](https://hackathon.flare.network/) and [Flare’s blogpost](https://flare.network/flare-x-google-cloud-hackathon/).
13-
148
## 🚀 Key Features
159

1610
- **Consensus Learning:** Provides a Python implementation of a single-node, multi-model of Consensus Learning, a decentralized ensemble learning approach described in [arXiv:2402.16157](https://arxiv.org/abs/2402.16157).
17-
- **Over 300 models supported:** Leverages LLMs via a centralized architecture using OpenAI's [OpenRouter](https://openrouter.ai/docs/quick-start).
11+
- **Over 300 models supported:** Leverages LLMs via a centralized architecture using [OpenRouter](https://openrouter.ai/docs/quick-start).
1812

1913
## Prerequisites
2014

21-
Install all dependencies using [uv](https://docs.astral.sh/uv/getting-started/installation/) by running:
22-
23-
```bash
24-
uv sync --all-extras
25-
```
15+
1. Install all dependencies using [uv](https://docs.astral.sh/uv/getting-started/installation/) by running:
2616

27-
### OpenAI API Key
17+
```bash
18+
uv sync --all-extras
19+
```
2820

29-
Generate an [OpenRouter API key](https://openrouter.ai/settings/keys) and set it in your environment variables. You can verify your available credits by running:
21+
2. Generate an [OpenRouter API key](https://openrouter.ai/settings/keys) and set it in your environment variables. You can verify your available credits by running:
3022

31-
```bash
32-
uv run python -m tests.credits
33-
```
23+
```bash
24+
uv run python -m tests.credits
25+
```
3426

3527
## OpenRouter Endpoints
3628

3729
The repository provides scripts to interact with OpenRouter:
3830

39-
- **List All Models:**
40-
Retrieves a list of all models.
41-
- **List Free Models:**
42-
Retrieves a list of all free models supported by OpenRouter.
31+
- **List All Models:** Retrieves a list of all models.
32+
- **List Free Models:** Retrieves a list of all free models supported by OpenRouter.
4333

4434
Run the following command to generate two JSON files in the `data` folder:
4535

4636
```bash
4737
uv run python -m tests.models
4838
```
4939

50-
**Note:**
51-
Free models are limited to 20 requests per minute and 200 requests per day.
40+
**Note:** Free models are limited to 20 requests/minute and 200 requests/day.
5241
Although all models should work in principle, some may return errors. To filter down to working free models, run:
5342

5443
```bash

0 commit comments

Comments
 (0)