shuto commited on
Commit ·
5969a9e
1
Parent(s): 7aaab79
Add virtual-fly overview model card
Browse files
README.md
CHANGED
|
@@ -1,3 +1,85 @@
|
|
| 1 |
---
|
| 2 |
license: mit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: mit
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
tags:
|
| 6 |
+
- drosophila
|
| 7 |
+
- connectome
|
| 8 |
+
- computational-neuroscience
|
| 9 |
+
- neuromodulation
|
| 10 |
+
- synaptic-plasticity
|
| 11 |
+
- embodied-simulation
|
| 12 |
+
- reproducible-research
|
| 13 |
---
|
| 14 |
+
|
| 15 |
+
# virtual-fly
|
| 16 |
+
|
| 17 |
+
`virtual-fly` is a research project that starts from the released adult male Drosophila MaleCNS connectome and evolves neural activity, neuromodulation, and local synaptic plasticity in closed loop with a FlyBody / MuJoCo body and a physical environment.
|
| 18 |
+
|
| 19 |
+
This Hugging Face repository is the **artifact-distribution overview** for the project. Source code, scientific documentation, canonical manifests, and the end-to-end reproducer live on GitHub:
|
| 20 |
+
|
| 21 |
+
- GitHub: https://github.com/shute2004/virtual-fly
|
| 22 |
+
- English documentation: https://github.com/shute2004/virtual-fly/tree/main/docs/en
|
| 23 |
+
- 日本語: https://github.com/shute2004/virtual-fly/blob/main/README.ja.md
|
| 24 |
+
- 简体中文: https://github.com/shute2004/virtual-fly/blob/main/README.zh-CN.md
|
| 25 |
+
|
| 26 |
+
## Checkpoint repositories
|
| 27 |
+
|
| 28 |
+
Two distinct lineages are published. **Do not treat the historical video pair as the canonical initial/trained pair.**
|
| 29 |
+
|
| 30 |
+
### Canonical v1
|
| 31 |
+
|
| 32 |
+
The canonical repository names receive their date only on the actual publication day.
|
| 33 |
+
|
| 34 |
+
| Artifact | Repository | Meaning |
|
| 35 |
+
|---|---|---|
|
| 36 |
+
| Initial | `shute2004/virtual-fly-initial-YYYYMMDD` | Initial checkpoint of canonical v1, global weight version 0 |
|
| 37 |
+
| Trained | `shute2004/virtual-fly-trained-YYYYMMDD` | Canonical v1 after six training episodes, global weight version 6 |
|
| 38 |
+
|
| 39 |
+
Canonical v1 is pinned to scientific Git commit `7fa464aad7269d34f46f1171080b51e095d1d811`. The short canonical run changed exactly 2,163,179 stored edges, but its frozen initial and final evaluations had the same categorical outcome. It therefore demonstrates current-semantics local-plasticity weight change, not established behavioral improvement.
|
| 40 |
+
|
| 41 |
+
### Historical Before / After video
|
| 42 |
+
|
| 43 |
+
| Artifact | Repository | Provenance role |
|
| 44 |
+
|---|---|---|
|
| 45 |
+
| Before | `shute2004/virtual-fly-video-before` | Exact historical checkpoint used for the Before side of the published comparison video |
|
| 46 |
+
| After | `shute2004/virtual-fly-video-after` | Exact historical checkpoint used for the After side of the published comparison video |
|
| 47 |
+
|
| 48 |
+
The historical cards record their internal development versions (`v240` and `v966`) as provenance, but those numbers are intentionally not used in the public repository names. These checkpoints come from older experiment lineages and are **not canonical v1 evidence**.
|
| 49 |
+
|
| 50 |
+
## What is hosted here
|
| 51 |
+
|
| 52 |
+
The artifact repositories contain checkpoint files plus lightweight provenance, hashes, attribution, and a model card. They do not mirror the full research workspace.
|
| 53 |
+
|
| 54 |
+
Not hosted here by default:
|
| 55 |
+
|
| 56 |
+
- raw MaleCNS downloads;
|
| 57 |
+
- normalized MaleCNS snapshots;
|
| 58 |
+
- FlyBody / FlyGym / MuJoCo source or body assets;
|
| 59 |
+
- full trajectory directories;
|
| 60 |
+
- rendered frame directories;
|
| 61 |
+
- unrelated development checkpoints;
|
| 62 |
+
- build caches or virtual environments.
|
| 63 |
+
|
| 64 |
+
The official MaleCNS source and the GitHub canonical reproducer remain the acquisition/reconstruction path for upstream data and derived static artifacts.
|
| 65 |
+
|
| 66 |
+
## Licensing and attribution
|
| 67 |
+
|
| 68 |
+
The original `virtual-fly` source code and documentation are MIT licensed. The checkpoint weights derive from the MaleCNS `male-cns:v1.0` dataset, which the official MaleCNS site distributes under CC BY 4.0. The checkpoint repositories are therefore marked `cc-by-4.0` and carry explicit MaleCNS attribution.
|
| 69 |
+
|
| 70 |
+
FlyBody, FlyGym, and MuJoCo remain under their upstream licenses and are not copied into the checkpoint repositories merely for convenience.
|
| 71 |
+
|
| 72 |
+
See the GitHub repository's `THIRD_PARTY_NOTICES.md` for the detailed boundary.
|
| 73 |
+
|
| 74 |
+
## Reproduction
|
| 75 |
+
|
| 76 |
+
For the current canonical experiment and full source-level provenance, use:
|
| 77 |
+
|
| 78 |
+
```bash
|
| 79 |
+
git clone https://github.com/shute2004/virtual-fly.git
|
| 80 |
+
cd virtual-fly
|
| 81 |
+
uv sync --frozen
|
| 82 |
+
bash canonical/canonical-v1/reproduce.sh
|
| 83 |
+
```
|
| 84 |
+
|
| 85 |
+
The Hugging Face checkpoint repositories are a distribution convenience. The GitHub canonical package remains the scientific definition of canonical v1.
|