Publish foundation Space template library
Browse files- README.md +51 -0
- templates/demo-release-checklist.md +25 -0
- templates/gradio-demo-readme.md +32 -0
- templates/safety-banner.md +7 -0
- templates/space-readme.base.md +46 -0
- templates/streamlit-demo-readme.md +32 -0
README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: other
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
tags:
|
| 6 |
+
- civic-ai
|
| 7 |
+
- space-template
|
| 8 |
+
- demo-safety
|
| 9 |
+
- public-trust
|
| 10 |
+
datasets: []
|
| 11 |
+
metrics: []
|
| 12 |
+
base_model: []
|
| 13 |
+
model-index: []
|
| 14 |
+
hf_release_status: template
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
# Foundation Space Templates
|
| 18 |
+
|
| 19 |
+
Status: Template / Scaffolded.
|
| 20 |
+
|
| 21 |
+
This Hugging Face documentation-style model repository is a Space README/template library. It is not a live Hugging Face Space and does not run app code.
|
| 22 |
+
|
| 23 |
+
No live demo is active. No model, dataset, or operational system is connected.
|
| 24 |
+
|
| 25 |
+
## Repository Type Boundary
|
| 26 |
+
|
| 27 |
+
This repository is intentionally published as a model/documentation repository, not as a Space. A future live Space requires separate human approval, runtime review, dependency review, and public-claim review.
|
| 28 |
+
|
| 29 |
+
## Purpose
|
| 30 |
+
|
| 31 |
+
This repository prepares static README templates, safety banners, and release checklists for future reviewed Foundation-aligned Spaces.
|
| 32 |
+
|
| 33 |
+
## Template Inventory
|
| 34 |
+
|
| 35 |
+
| Template | Use |
|
| 36 |
+
| --- | --- |
|
| 37 |
+
| `templates/space-readme.base.md` | Base Space README structure. |
|
| 38 |
+
| `templates/gradio-demo-readme.md` | Gradio demo README variant for reviewed demos. |
|
| 39 |
+
| `templates/streamlit-demo-readme.md` | Streamlit demo README variant for reviewed demos. |
|
| 40 |
+
| `templates/safety-banner.md` | Standard safety and limitation banner. |
|
| 41 |
+
| `templates/demo-release-checklist.md` | Demo release checklist. |
|
| 42 |
+
|
| 43 |
+
## Public Exclusions
|
| 44 |
+
|
| 45 |
+
Forbidden material includes runnable app code unless approved, live Space secrets, model weights, dataset files, donor data, student data, volunteer data, customer data, private Foundation operations, private telemetry, exact sensitive infrastructure locations, private training corpora, sealed IP, and security-sensitive NEURONA operational details.
|
| 46 |
+
|
| 47 |
+
## Companion Links
|
| 48 |
+
|
| 49 |
+
- GitHub Space companion: https://github.com/K-ussade/foundation-spaces
|
| 50 |
+
- Safety companion: https://github.com/K-ussade/civic-ai-safety-notes
|
| 51 |
+
- HF index companion: https://github.com/K-ussade/foundation-huggingface-index
|
templates/demo-release-checklist.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Demo Release Checklist
|
| 2 |
+
|
| 3 |
+
## Status
|
| 4 |
+
|
| 5 |
+
`{Planned / Not released}`
|
| 6 |
+
|
| 7 |
+
## Required Before Launch
|
| 8 |
+
|
| 9 |
+
| Gate | Required Evidence | Status |
|
| 10 |
+
| --- | --- | --- |
|
| 11 |
+
| Space README complete | Status, scope, limitations, dependencies, contact path | `{Pending}` |
|
| 12 |
+
| Runtime review complete | App code and dependency behavior reviewed | `{Pending}` |
|
| 13 |
+
| Model dependency review | Only reviewed released models, or no model dependency | `{Pending}` |
|
| 14 |
+
| Dataset dependency review | Only reviewed released datasets, or no dataset dependency | `{Pending}` |
|
| 15 |
+
| Privacy review complete | No private submissions, logs, telemetry, or sensitive data collection | `{Pending}` |
|
| 16 |
+
| Safety banner complete | Informational demo and no official-service boundary | `{Pending}` |
|
| 17 |
+
| Human release approval complete | Named reviewer and date | `{Pending}` |
|
| 18 |
+
|
| 19 |
+
## Launch Blockers
|
| 20 |
+
|
| 21 |
+
- Live demo without human approval.
|
| 22 |
+
- Connected model, dataset, or operational system without review.
|
| 23 |
+
- Private data collection.
|
| 24 |
+
- Credentials, secrets, tokens, or sensitive infrastructure details.
|
| 25 |
+
- Claims of deployed Foundation services, schools, NEURONAs, reports, trading systems, or outcomes without public evidence and review.
|
templates/gradio-demo-readme.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: "{SPACE_NAME}"
|
| 3 |
+
sdk: gradio
|
| 4 |
+
app_file: app.py
|
| 5 |
+
pinned: false
|
| 6 |
+
license: other
|
| 7 |
+
tags:
|
| 8 |
+
- civic-ai
|
| 9 |
+
- gradio
|
| 10 |
+
- demo-safety
|
| 11 |
+
hf_release_status: planned
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
# {SPACE_NAME}
|
| 15 |
+
|
| 16 |
+
Status: {Planned / Not released | Scaffolded | Released}
|
| 17 |
+
|
| 18 |
+
## Demo Scope
|
| 19 |
+
|
| 20 |
+
This template is for a future Gradio demo after dependency, safety, privacy, and publication review.
|
| 21 |
+
|
| 22 |
+
## Runtime Boundary
|
| 23 |
+
|
| 24 |
+
Do not add `app.py`, credentials, model dependencies, dataset dependencies, or data-collection behavior until human review approves the exact demo scope.
|
| 25 |
+
|
| 26 |
+
## Safety Limits
|
| 27 |
+
|
| 28 |
+
The demo must be informational only and must not make emergency, legal, medical, financial, eligibility, enforcement, operational, education-placement, or individualized support decisions.
|
| 29 |
+
|
| 30 |
+
## Data Boundary
|
| 31 |
+
|
| 32 |
+
Do not accept or store donor data, student data, volunteer data, customer data, private Foundation operations, private telemetry, private reports, exact sensitive infrastructure locations, or sealed IP.
|
templates/safety-banner.md
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Safety Banner
|
| 2 |
+
|
| 3 |
+
This demo is informational and review-gated. It is not an official emergency channel, government service, legal adviser, medical adviser, financial adviser, investment adviser, eligibility system, enforcement system, operational control system, or trading system.
|
| 4 |
+
|
| 5 |
+
Do not submit donor data, student data, volunteer private data, customer data, private reports, private telemetry, private Foundation operations, precise sensitive infrastructure locations, secrets, credentials, or sealed material.
|
| 6 |
+
|
| 7 |
+
Outputs require human review before public reliance or operational use.
|
templates/space-readme.base.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: "{SPACE_NAME}"
|
| 3 |
+
sdk: static
|
| 4 |
+
pinned: false
|
| 5 |
+
license: other
|
| 6 |
+
tags:
|
| 7 |
+
- civic-ai
|
| 8 |
+
- space
|
| 9 |
+
hf_release_status: planned
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
+
# {SPACE_NAME}
|
| 13 |
+
|
| 14 |
+
Status: {Planned / Not released | Scaffolded | Released}
|
| 15 |
+
|
| 16 |
+
## Demo Scope
|
| 17 |
+
|
| 18 |
+
{Describe what the demo does in public-safe terms.}
|
| 19 |
+
|
| 20 |
+
## What This Demo Does Not Do
|
| 21 |
+
|
| 22 |
+
- It is not an official emergency, government, legal, medical, financial, eligibility, enforcement, or operational channel.
|
| 23 |
+
- It does not accept private reports, donor data, student data, volunteer data, customer data, or private telemetry.
|
| 24 |
+
- It does not connect to private Foundation operations, sealed source, or security-sensitive NEURONA systems.
|
| 25 |
+
|
| 26 |
+
## Dependencies
|
| 27 |
+
|
| 28 |
+
| Dependency | Status |
|
| 29 |
+
| --- | --- |
|
| 30 |
+
| Model | `{None / released model URL}` |
|
| 31 |
+
| Dataset | `{None / released dataset URL}` |
|
| 32 |
+
| GitHub companion | `{URL}` |
|
| 33 |
+
|
| 34 |
+
## Safety Banner
|
| 35 |
+
|
| 36 |
+
{Insert reviewed safety banner.}
|
| 37 |
+
|
| 38 |
+
## Review Status
|
| 39 |
+
|
| 40 |
+
| Gate | Status |
|
| 41 |
+
| --- | --- |
|
| 42 |
+
| Demo scope review | `{Pending}` |
|
| 43 |
+
| Dependency review | `{Pending}` |
|
| 44 |
+
| Privacy review | `{Pending}` |
|
| 45 |
+
| Safety review | `{Pending}` |
|
| 46 |
+
| Human release approval | `{Pending}` |
|
templates/streamlit-demo-readme.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: "{SPACE_NAME}"
|
| 3 |
+
sdk: streamlit
|
| 4 |
+
app_file: app.py
|
| 5 |
+
pinned: false
|
| 6 |
+
license: other
|
| 7 |
+
tags:
|
| 8 |
+
- civic-ai
|
| 9 |
+
- streamlit
|
| 10 |
+
- demo-safety
|
| 11 |
+
hf_release_status: planned
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
# {SPACE_NAME}
|
| 15 |
+
|
| 16 |
+
Status: {Planned / Not released | Scaffolded | Released}
|
| 17 |
+
|
| 18 |
+
## Demo Scope
|
| 19 |
+
|
| 20 |
+
This template is for a future Streamlit demo after dependency, safety, privacy, and publication review.
|
| 21 |
+
|
| 22 |
+
## Runtime Boundary
|
| 23 |
+
|
| 24 |
+
Do not add `app.py`, credentials, model dependencies, dataset dependencies, or data-collection behavior until human review approves the exact demo scope.
|
| 25 |
+
|
| 26 |
+
## Safety Limits
|
| 27 |
+
|
| 28 |
+
The demo must be informational only and must not serve as an official service, emergency channel, operational dashboard, trading system, or decision engine.
|
| 29 |
+
|
| 30 |
+
## Data Boundary
|
| 31 |
+
|
| 32 |
+
Do not accept or store donor data, student data, volunteer data, customer data, private Foundation operations, private telemetry, private reports, exact sensitive infrastructure locations, or sealed IP.
|