kameshcodes commited on
Commit
3a18f94
·
1 Parent(s): 7bb0af0

docs: add HF Spaces deployment, LFS setup, and update README with screenshot and install instructions

Browse files
.github/workflows/sync-to-hf.yml ADDED
@@ -0,0 +1,25 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Sync to Hugging Face Spaces
2
+ on:
3
+ push:
4
+ branches: [main]
5
+ workflow_dispatch:
6
+
7
+ jobs:
8
+ sync-to-hub:
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - uses: actions/checkout@v3
12
+ with:
13
+ fetch-depth: 0
14
+ lfs: true
15
+ - name: Migrate binary files to Git LFS
16
+ run: |
17
+ git config user.email "github-actions@github.com"
18
+ git config user.name "GitHub Actions"
19
+ git lfs install
20
+ git stash || true
21
+ git lfs migrate import --include="*.png,*.jpg,*.jpeg,*.gif" --everything --yes
22
+ - name: Push to Hugging Face
23
+ env:
24
+ HF_TOKEN: ${{ secrets.HF_TOKEN }}
25
+ run: git push --force https://kameshcodes:$HF_TOKEN@huggingface.co/spaces/kameshcodes/value-at-risk main
.gitignore CHANGED
@@ -10,4 +10,5 @@ wheels/
10
  .venv
11
  .gradio
12
  log/
13
- output/
 
 
10
  .venv
11
  .gradio
12
  log/
13
+ output/
14
+ .env
README.md CHANGED
@@ -1,7 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
  # VaR Engine
2
 
3
  An interactive web app to compute **Value at Risk (VaR)** and **Expected Shortfall (ES)** for equities, featuring an interactive Gradio UI and **audit-ready Excel reports with embedded formulas**.
4
 
 
5
 
6
  ## Features
7
 
@@ -13,6 +26,11 @@ An interactive web app to compute **Value at Risk (VaR)** and **Expected Shortfa
13
 
14
  ## Getting Started
15
 
 
 
 
 
 
16
  ### Option 1: Using `uv` (Recommended)
17
 
18
  1. **Sync the environment**:
 
1
+ ---
2
+ title: VaR Engine
3
+ emoji: 📉
4
+ colorFrom: blue
5
+ colorTo: red
6
+ sdk: gradio
7
+ sdk_version: "6.9.0"
8
+ python_version: "3.13"
9
+ app_file: app.py
10
+ pinned: false
11
+ ---
12
+
13
  # VaR Engine
14
 
15
  An interactive web app to compute **Value at Risk (VaR)** and **Expected Shortfall (ES)** for equities, featuring an interactive Gradio UI and **audit-ready Excel reports with embedded formulas**.
16
 
17
+ ![App Screenshot](assets/screenshot.png)
18
 
19
  ## Features
20
 
 
26
 
27
  ## Getting Started
28
 
29
+ ```bash
30
+ git clone https://github.com/kameshcodes/value-at-risk.git
31
+ cd value-at-risk
32
+ ```
33
+
34
  ### Option 1: Using `uv` (Recommended)
35
 
36
  1. **Sync the environment**:
assets/screenshot.png ADDED

Git LFS Details

  • SHA256: 8a5946125c603e5eb82e82bad97055fdc73c7f19ea962fb69ac5b5ec04224e19
  • Pointer size: 131 Bytes
  • Size of remote file: 281 kB