Skip to content

Commit 0618325

Browse files
committed
feat: make the readme based on structure
1 parent f9ab208 commit 0618325

File tree

2 files changed

+33
-65
lines changed

2 files changed

+33
-65
lines changed

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Flare AI SDK for Consensus Learning.
1919
- **Modular & Configurable**
2020
Easily customize models, conversation prompts, and aggregation parameters through a simple JSON configuration.
2121

22-
## 📌 Prerequisites
22+
## 🎯 Getting Started
2323

2424
Before getting started, ensure you have:
2525

2626
- A **Python 3.12** environment.
2727
- [uv](https://docs.astral.sh/uv/getting-started/installation/) installed for dependency management.
2828
- An [OpenRouter API Key](https://openrouter.ai/settings/keys).
2929

30-
## ⚙️ Environment Setup
30+
### Environment Setup
3131

3232
### Step 1: Install Dependencies
3333

@@ -48,7 +48,7 @@ uv run python -m tests.credits
4848
uv run python -m tests.models
4949
```
5050

51-
## 🚀 Running Consensus Learning
51+
### Running Consensus Learning
5252

5353
Configure your consensus learning instance in `src/input.json`, including:
5454

@@ -70,7 +70,7 @@ Once configured, start the process with:
7070
uv run start-consensus
7171
```
7272

73-
## 🔧 Testing Endpoints
73+
### Testing Endpoints
7474

7575
For granular testing, use the following endpoints:
7676

@@ -88,6 +88,33 @@ For granular testing, use the following endpoints:
8888

8989
_Tip:_ In interactive mode, type `exit` to quit.
9090

91+
## 📁 Repo Structure
92+
93+
```
94+
src/flare_ai_consensus/
95+
├── attestation/ # TEE attestation implementation
96+
│ ├── __init__.py
97+
│ ├── simulated_token.txt
98+
│ ├── vtpm_attestation.py
99+
│ └── vtpm_validation.py
100+
├── consensus/ # Core consensus learning
101+
│ ├── __init__.py
102+
│ ├── aggregator.py # Response aggregation
103+
│ └── consensus.py # Main CL implementation
104+
├── router/ # API routing and model access
105+
│ ├── __init__.py
106+
│ ├── base_router.py # Base routing interface
107+
│ └── openrouter.py # OpenRouter implementation
108+
├── utils/ # Utility functions
109+
│ ├── __init__.py
110+
│ ├── file_utils.py # File operations
111+
│ └── parser_utils.py # Input parsing
112+
├── __init__.py
113+
├── input.json # Configuration file
114+
├── main.py # Application entry
115+
└── settings.py # Environment settings
116+
```
117+
91118
## 🚀 Deploy on TEE
92119

93120
Deploy on a [Confidential Space](https://cloud.google.com/confidential-computing/confidential-space/docs/confidential-space-overview) using AMD SEV.
@@ -195,7 +222,7 @@ If you encounter issues, follow these steps:
195222
3. **Check Firewall Settings:**
196223
Confirm that your instance is publicly accessible on port `80`.
197224

198-
## 🔜 Next Steps & Future Directions
225+
## 💡 Next Steps
199226

200227
- **Security & TEE Integration:**
201228
- Ensure execution within a Trusted Execution Environment (TEE) to maintain confidentiality and integrity.

uv.lock

Lines changed: 1 addition & 60 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)