Chaser111 commited on
Commit
b349426
·
verified ·
1 Parent(s): 9897f2e

Publish pre-release artifact card

Browse files
Files changed (1) hide show
  1. README.md +120 -0
README.md ADDED
@@ -0,0 +1,120 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+
3
+ <!-- SPDX-License-Identifier: CC-BY-4.0 -->
4
+ pretty_name: Microfluidic Native Physics - Reproducibility Artifacts
5
+ language:
6
+ - en
7
+ - zh
8
+ license: other
9
+ task_categories:
10
+ - tabular-regression
11
+ tags:
12
+ - microfluidics
13
+ - droplet-generation
14
+ - distribution-shift
15
+ - physics-guided-machine-learning
16
+ - applicability-domain
17
+ - conformal-prediction
18
+ ---
19
+
20
+ # Microfluidic Native Physics — reproducibility artifacts
21
+
22
+ > **Publication pending.** This card is staged for the future Hugging Face
23
+ > dataset repository
24
+ > [Chaser111/microfluidic-native-physics](https://huggingface.co/datasets/Chaser111/microfluidic-native-physics).
25
+ > No artifact upload is VERIFIED until the matching GitHub commit/tag, hashes,
26
+ > source terms, and schemas are filled below.
27
+
28
+ The canonical project, implementation, protocols, tests, and issue history are
29
+ hosted on GitHub:
30
+
31
+ **[LibertychaserUS/microfluidic-native-physics](https://github.com/LibertychaserUS/microfluidic-native-physics)**
32
+
33
+ Author: **Zhiyuan Zhang**
34
+
35
+ ## Scope
36
+
37
+ This repository is intended to mirror license-cleared reproducibility artifacts
38
+ for a retrospective public-data study of reliability under chemistry shift in
39
+ droplet microfluidics. Planned content includes split manifests, per-row model
40
+ predictions, applicability scores, uncertainty bands, strict metrics tables,
41
+ figure-source tables, and artifact hashes.
42
+
43
+ It is not a new wet-lab dataset. It does not establish chemical compatibility,
44
+ manufacturability, stable dripping, device safety, or prospective material or
45
+ formulation discovery.
46
+
47
+ ## Evidence boundary
48
+
49
+ - **V1:** a complete TX100 chemistry group was sealed. The held-out result was
50
+ negative (MAPE 19.8436%, R-squared -0.2436, nominal 90% interval coverage
51
+ 44.83%). The reveal required a disclosed serialization-only recovery after a
52
+ strict JSON write rejected an undefined value. Frozen predictions and labels
53
+ were not changed.
54
+ - **V2:** a native-variable physics-guided constrained regressor, not a
55
+ classical PINN. TX100 was already revealed, so V2 results on TX100 are
56
+ retrospective, not a second blind validation.
57
+ - **Search:** retrospective ranking/retrieval of historical candidates, not
58
+ prospective experiment-free validation.
59
+
60
+ ## Planned files
61
+
62
+ | Path | Description | Status |
63
+ |---|---|---|
64
+ | `manifests/` | Source, split, environment, and artifact hashes | pending |
65
+ | `predictions/` | Per-row predictions, intervals, and risk scores | pending |
66
+ | `metrics/` | Strict JSON/CSV endpoint summaries | pending |
67
+ | `figure_data/` | Tables used to regenerate paper figures | pending |
68
+ | `README.md` | This dataset card | staged |
69
+
70
+ Before publication, each file will list its schema, row unit, generating GitHub
71
+ commit, source-data dependency, license boundary, and SHA-256 hash.
72
+
73
+ ## Source data
74
+
75
+ This mirror does not relicense upstream data.
76
+
77
+ - Chagot et al. article:
78
+ [Lab on a Chip](https://pubs.rsc.org/en/content/articlehtml/2022/lc/d2lc00416j)
79
+ - Chagot public tables:
80
+ [Zenodo 7055018](https://zenodo.org/records/7055018), whose record reports
81
+ CC BY 4.0
82
+ - Lashkaripour et al. DAFD article:
83
+ [Nature Communications](https://www.nature.com/articles/s41467-023-44068-3)
84
+ - DAFD deposit used by the reproduction:
85
+ [OSF 938rs](https://osf.io/938rs/)
86
+
87
+ Only artifacts cleared under the applicable source terms will be uploaded.
88
+ The GitHub project's Apache-2.0 license applies to original software code,
89
+ tests, and configuration. Repository-authored report text and original
90
+ figures/results use CC BY 4.0. Neither license automatically applies to upstream
91
+ data or overrides rights retained in data-derived content.
92
+
93
+ ## Reproducibility pointer
94
+
95
+ Pending release metadata:
96
+
97
+ ```text
98
+ GitHub commit: PENDING
99
+ GitHub release/tag: PENDING
100
+ Artifact manifest SHA-256: PENDING
101
+ Schema version: PENDING
102
+ ```
103
+
104
+ Reproduction commands and dependency locks will live in the canonical GitHub
105
+ repository. This HF repository will not contain an independent, drifting copy
106
+ of the implementation.
107
+
108
+ ## Citation
109
+
110
+ Use the canonical GitHub
111
+ [`CITATION.cff`](https://github.com/LibertychaserUS/microfluidic-native-physics/blob/main/CITATION.cff)
112
+ after the first tagged release. No DOI or arXiv identifier has been assigned.
113
+
114
+ ## 中文说明
115
+
116
+ 这里计划只发布经过许可核验的复现实验产物,例如逐行预测、数据切分清单、
117
+ 指标表和哈希。GitHub 是唯一主仓库,HF 不单独维护算法代码。
118
+
119
+ V1 的整组 TX100 留出测试是负结果;V2 是“原生变量 + 物理引导 + 硬约束”,
120
+ 不是经典 PINN;所有搜索均为历史公开数据回放,没有做新的湿实验验证。