Add Hugging Face README config
Browse files
README.md
CHANGED
|
@@ -1,52 +1,11 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
## Setup & Installation
|
| 14 |
-
|
| 15 |
-
### Prerequisites
|
| 16 |
-
* [Miniconda](https://docs.anaconda.com/free/miniconda/) or Anaconda installed.
|
| 17 |
-
* Google Earth Engine account/credentials.
|
| 18 |
-
* Hugging Face API Token.
|
| 19 |
-
|
| 20 |
-
### 1. Create the Environment
|
| 21 |
-
Due to complex C++ dependencies for PyTorch Geometric on Windows, use the provided Conda environment file:
|
| 22 |
-
```bash
|
| 23 |
-
conda env create -f environment.yml
|
| 24 |
-
conda activate glof_agent
|
| 25 |
-
```
|
| 26 |
-
|
| 27 |
-
### 2. Environment Variables
|
| 28 |
-
You must set your Hugging Face API token in your environment (or create a `.env` file):
|
| 29 |
-
```bash
|
| 30 |
-
setx HF_TOKEN "your_hf_token_here"
|
| 31 |
-
```
|
| 32 |
-
|
| 33 |
-
### 3. Run the Application
|
| 34 |
-
You can start both the backend FastAPI server and the frontend web interface simply by running:
|
| 35 |
-
```bash
|
| 36 |
-
run_application.bat
|
| 37 |
-
```
|
| 38 |
-
*(Alternatively, you can run `python chatbot/chat_server.py` and serve the `website/` folder manually).*
|
| 39 |
-
|
| 40 |
-
## Repository Structure
|
| 41 |
-
* `chatbot/`: The core Agentic RAG logic, routing, Earth Engine fetching, and dual-inference scripts.
|
| 42 |
-
* `models/`: Pre-trained weights for the GNN (`.pth`), Lake Segmentation U-Net (`.pth`), and XGBoost (`.joblib`).
|
| 43 |
-
* `gis_data/`: Geopackages (`.gpkg`) containing the static river networks, glacial lake boundaries, and building footprints.
|
| 44 |
-
* `rag/`: Vector indices and the semantic Knowledge Graph (`.ttl`).
|
| 45 |
-
* `website/`: The HTML/JS/CSS code for the interactive Mapbox frontend.
|
| 46 |
-
|
| 47 |
-
## Git Large File Storage (LFS)
|
| 48 |
-
This repository uses Git LFS to host heavy model weights and `.gpkg` files. If you clone this repository, make sure you have Git LFS installed to pull the actual files rather than their pointer references:
|
| 49 |
-
```bash
|
| 50 |
-
git lfs install
|
| 51 |
-
git lfs pull
|
| 52 |
-
```
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: GLOF Backend API
|
| 3 |
+
emoji: 🌊
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: indigo
|
| 6 |
+
sdk: docker
|
| 7 |
+
pinned: false
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
# GLOF Backend API
|
| 11 |
+
This is the Docker backend for the GLOF Agentic RAG System.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|