virtual-fly / README.md
shuto
Align canonical provenance with clean GitHub repository
db316f9
|
Raw History Blame
4.83 kB
metadata
license: mit
language:
  - en
  - ja
  - zh
tags:
  - drosophila
  - connectome
  - computational-neuroscience
  - neuromodulation
  - synaptic-plasticity
  - embodied-simulation
  - reproducible-research

virtual-fly

English · 日本語 · 简体中文

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.

This Hugging Face repository provides an overview of virtual-fly and describes the checkpoint repositories prepared for the first public checkpoint release. Source code, scientific documentation, canonical manifests, and the end-to-end reproducer live on GitHub:

Checkpoint repositories

The prepared checkpoint release has two distinct lineages. The four checkpoint repositories listed below are not created or public yet. Do not treat the historical video pair as the canonical initial/trained pair.

Canonical v1

The canonical repository names receive their date only on the actual publication day.

Checkpoint Repository Meaning
Initial shute2004/virtual-fly-initial-YYYYMMDD Initial checkpoint of canonical v1, global weight version 0
Trained shute2004/virtual-fly-trained-YYYYMMDD Canonical v1 after six training episodes, global weight version 6

The recorded canonical v1 experiment was actually run at Git commit 7fa464aad7269d34f46f1171080b51e095d1d811. Before public release, a privacy-only history rewrite produced public scientific equivalent f9c86c904d67ff974f3c43d37aab3619bc93fc1b; only historical absolute-path usernames changed, not executable source or canonical conditions. 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.

Historical Before / After video

Checkpoint Repository Provenance role
Before shute2004/virtual-fly-video-before Exact historical checkpoint used for the Before side of the published comparison video
After shute2004/virtual-fly-video-after Exact historical checkpoint used for the After side of the published comparison video

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. The Before checkpoint is already a historically trained v240 state, not an untrained initial state; the playback was not held out and retained task-triggered PAM stimulation while plasticity was off. The v966 checkpoint belongs to a mixed older lineage. These checkpoints are not canonical v1 evidence.

What is hosted here

When published, the checkpoint repositories will contain checkpoint files plus lightweight provenance, hashes, attribution, and a model card. They do not mirror the full research workspace.

Not hosted here by default:

  • raw MaleCNS downloads;
  • normalized MaleCNS snapshots;
  • FlyBody / FlyGym / MuJoCo source or body assets;
  • full trajectory directories;
  • rendered frame directories;
  • unrelated development checkpoints;
  • build caches or virtual environments.

The official MaleCNS source and the GitHub canonical reproducer remain the acquisition/reconstruction path for upstream data and derived static data.

Licensing and attribution

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.

FlyBody, FlyGym, and MuJoCo remain under their upstream licenses and are not copied into the checkpoint repositories merely for convenience.

See the GitHub repository's THIRD_PARTY_NOTICES.md for the detailed boundary.

Reproduction

For the current canonical experiment and full source-level provenance, use:

git clone https://github.com/shute2004/virtual-fly.git
cd virtual-fly
uv sync --frozen
bash canonical/canonical-v1/reproduce.sh

The Hugging Face checkpoint repositories are a distribution convenience. The GitHub canonical package remains the scientific definition of canonical v1.