bpmredacademy commited on
Commit
aa0527a
·
verified ·
1 Parent(s): 84e9bed

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +95 -0
README.md CHANGED
@@ -71,3 +71,98 @@ For reproducible tests and mirrors (NGC / Brev), use **`1.0.0`**.
71
  ### Pull image
72
  ```bash
73
  docker pull registry.huggingface.co/MightHubHumAI/FinC2E_DualMetrics_Runtime:1.0.0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
  ### Pull image
72
  ```bash
73
  docker pull registry.huggingface.co/MightHubHumAI/FinC2E_DualMetrics_Runtime:1.0.0
74
+ Run container
75
+ docker run --rm \
76
+ -e HF_TOKEN=YOUR_HF_TOKEN \
77
+ -e ADAPTER_REPO=MightHubHumAI/FinC2E_Llama33_70B_Adapter \
78
+ -p 8000:8000 \
79
+ registry.huggingface.co/MightHubHumAI/FinC2E_DualMetrics_Runtime:1.0.0
80
+
81
+
82
+ HF_TOKEN must have read access to the private adapter repository.
83
+
84
+ Endpoints
85
+ Health
86
+ curl http://localhost:8000/health
87
+
88
+
89
+ Example response:
90
+
91
+ {"status":"ok","service":"FinC2E Runtime"}
92
+
93
+ Dual Metrics
94
+ curl http://localhost:8000/metrics
95
+
96
+
97
+ Example response:
98
+
99
+ {
100
+ "runtime": "FinC2E_DualMetrics_Runtime",
101
+ "adapter_repo": "MightHubHumAI/FinC2E_Llama33_70B_Adapter",
102
+ "download_seconds": 4.242,
103
+ "timestamp": "2025-09-16T14:30:00Z"
104
+ }
105
+
106
+ Environment Variables
107
+
108
+ HF_TOKEN (required)
109
+ Hugging Face token with permission to access the private adapter repository.
110
+
111
+ ADAPTER_REPO (optional)
112
+ Defaults to MightHubHumAI/FinC2E_Llama33_70B_Adapter.
113
+
114
+ PORT (optional)
115
+ Defaults to 8000.
116
+
117
+ Security & IP Model
118
+
119
+ Adapter weights are private and never embedded in the image.
120
+
121
+ Runtime image is public, auditable, and mirrorable.
122
+
123
+ This separation enables:
124
+
125
+ controlled access
126
+
127
+ governance and audit readiness
128
+
129
+ Hugging Face → NVIDIA NGC parity
130
+
131
+ Brev and enterprise deployment flows
132
+
133
+ Release Notes — v1.0.0
134
+
135
+ First public runtime release.
136
+
137
+ Secure adapter pull via HF_TOKEN.
138
+
139
+ /health and /metrics endpoints available.
140
+
141
+ Immutable 1.0.0 tag + rolling latest.
142
+
143
+ HF → NGC → Brev Shared Release Discipline
144
+
145
+ Hugging Face tag 1.0.0 == NVIDIA NGC tag 1.0.0.
146
+
147
+ No breaking changes under the same tag.
148
+
149
+ All future changes increment semver (1.0.1, 1.1.0, 2.0.0).
150
+
151
+ This ensures deterministic behavior across registries and deployment platforms.
152
+
153
+ Roadmap
154
+
155
+ Upcoming iterations include:
156
+
157
+ Decision trace endpoints (JSONL, audit-ready).
158
+
159
+ Model routing and orchestration hooks (Galaxy container foundations).
160
+
161
+ NVIDIA NGC packaging and listing.
162
+
163
+ Brev deployment profiles for GPU-backed environments.
164
+
165
+ License
166
+
167
+ Apache-2.0 applies to runtime code and container packaging.
168
+ Model adapters and weights are governed separately under a private license.