README.md

---
title: FLaME - Financial Language Model Evaluation
emoji: 📊
colorFrom: blue
colorTo: yellow
sdk: static
pinned: false
license: cc-by-sa-4.0
---

# FLaME: Holistic Financial Language Model Evaluation

Website for the FLaME research project showcasing our benchmarking suite for evaluating language models on financial NLP tasks.

## Local Development

To serve the website locally, run:

```bash
python -m http.server 8000
```

Then open your browser to http://localhost:8000

## Deploying to HuggingFace Spaces

1. Create a new Space on HuggingFace:
   - Visit https://huggingface.co/spaces
   - Click "Create new Space"
   - Choose a name for your space (e.g., "flame-benchmark")
   - Select "Static" as the Space SDK
   - Set visibility as desired (public/private)

2. Push your code to the Space:
   ```bash
   # Initialize git if not already done
   git init
   
   # Add the HuggingFace Space as a remote
   git remote add space https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME
   
   # Add and commit your files
   git add .
   git commit -m "Initial commit"
   
   # Push to HuggingFace Spaces
   git push space main
   ```

3. Your website will be deployed at: https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME

## Required Updates Before Deployment

1. **Convert PDF figures to web-friendly formats**:
   - Convert `content/figures/fig_overview_tech.pdf` to JPG or PNG
   - Place in `static/images/` folder
   - Update the image src in `index.html`

2. **Update author information**:
   - Replace placeholder author names with actual authors
   - Add correct affiliations

3. **Add links**:
   - Update the Paper link to point to your actual PDF
   - Add GitHub repository link if available
   - Add arXiv link when available
   - Add dataset link if applicable

4. **Update BibTeX**:
   - Add the correct citation information

## Citation

If you find FLaME useful for your work please cite:
```
@article{flame2025,
  author    = {Authors},
  title     = {FLaME: Holistic Financial Language Model Evaluation},
  journal   = {ACL},
  year      = {2025},
}
```

## Website License
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This website is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.