chq1155 commited on
Commit
8142838
·
verified ·
1 Parent(s): b1a1b0a

Add NOTICE (third-party attribution); scrub internal paths from demo provenance; fix project URLs to ChatterjeeLab org

Browse files
Files changed (3) hide show
  1. NOTICE +25 -0
  2. examples/data/provenance.md +8 -11
  3. pyproject.toml +2 -2
NOTICE ADDED
@@ -0,0 +1,25 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ SF-Cluster
2
+ Copyright (c) 2026 Hanqun Cao
3
+
4
+ This software builds on the following third-party work, which it depends on at
5
+ runtime but does NOT redistribute. Each retains its own license and authorship.
6
+
7
+ 1. FrustrAI-Seq — per-residue frustration prediction model.
8
+ License: Apache-2.0.
9
+ Source: https://github.com/leuschjanphilipp/FrustrAI-Seq
10
+ Weights: https://huggingface.co/leuschj/FrustrAI-Seq
11
+ SF-Cluster calls this model to compute the frustration features that guide
12
+ MSA subsampling. Install and weights are fetched from the upstream sources.
13
+
14
+ 2. ProtT5 (Rostlab/prot_t5_xl_half_uniref50-enc) — protein language model used
15
+ internally by FrustrAI-Seq.
16
+ Source: https://huggingface.co/Rostlab/prot_t5_xl_half_uniref50-enc
17
+
18
+ 3. AF-Cluster (Wayment-Steele et al.) — the MSA-clustering method SF-Cluster is
19
+ compared against and conceptually extends.
20
+ License: MIT.
21
+ Source: https://github.com/HWaymentSteele/AF_Cluster
22
+
23
+ AlphaFold2 / ColabFold are used as the downstream structure predictor and are
24
+ neither included nor wrapped by this package; install them separately under
25
+ their own licenses.
examples/data/provenance.md CHANGED
@@ -13,17 +13,14 @@ outputs.
13
  | `KaiB_fi_matrix.npy` | (364, 91) float32 | Per-residue FI matrix. Row `i` corresponds to record `i` in the A3M. |
14
  | `KaiB_seq_ids.txt` | 364 lines | One short sequence ID per line, in the same order as the A3M / FI matrix. |
15
 
16
- ## Source paths (private dev repo, read-only)
17
-
18
- - Filtered MSA:
19
- `/data1/hanqun/SF-Design/SF-Cluster/data/processed/msa/KaiB/KaiB/KaiB_KaiBTE_91aa_UniProt_Q79V61_5to95_2QKE_chainB.filtered.a3m`
20
- (depth 6821, L=91)
21
- - FI artifacts (per-subset):
22
- `/data1/hanqun/SF-Design/SF-Cluster/results/frustai_artifacts/KaiB/diverse_sf/KaiB/{000..011}/`
23
- with files `fi_matrix.npy` ((32, 91) float32), `metadata.json`,
24
- `fi_residual_matrix.npy`, `entropy_matrix.npy`.
25
- - Source subset A3Ms (used to map FI rows → sequence IDs):
26
- `/data1/hanqun/SF-Design/SF-Cluster/results/baseline_p8/diverse_sf/KaiB/KaiB/screen/diversesf_KaiB_KaiB_seed{000..011}.a3m`.
27
 
28
  ## Construction recipe
29
 
 
13
  | `KaiB_fi_matrix.npy` | (364, 91) float32 | Per-residue FI matrix. Row `i` corresponds to record `i` in the A3M. |
14
  | `KaiB_seq_ids.txt` | 364 lines | One short sequence ID per line, in the same order as the A3M / FI matrix. |
15
 
16
+ ## Provenance (internal source paths omitted)
17
+
18
+ Derived from the SF-Cluster Phase II KaiB `diverse_sf` benchmark arm: the
19
+ filtered KaiB MSA (depth 6821, L=91) and the per-subset FrustrAI-Seq FI
20
+ artifacts (12 subsets, each a `(32, 91)` float32 `fi_matrix.npy` with
21
+ `metadata.json`, `fi_residual_matrix.npy`, `entropy_matrix.npy`) mapped back to
22
+ the 12 subset A3Ms to recover sequence IDs. Internal dev-repo paths are omitted
23
+ from this public demo asset.
 
 
 
24
 
25
  ## Construction recipe
26
 
pyproject.toml CHANGED
@@ -33,8 +33,8 @@ dev = ["pytest>=7.0"]
33
  sf-cluster = "sf_cluster.cli:main"
34
 
35
  [project.urls]
36
- Homepage = "https://github.com/hanqun-cao/sf-cluster"
37
- Issues = "https://github.com/hanqun-cao/sf-cluster/issues"
38
 
39
  [tool.setuptools.packages.find]
40
  where = ["src"]
 
33
  sf-cluster = "sf_cluster.cli:main"
34
 
35
  [project.urls]
36
+ Homepage = "https://github.com/ChatterjeeLab/SF-Cluster"
37
+ Issues = "https://github.com/ChatterjeeLab/SF-Cluster/issues"
38
 
39
  [tool.setuptools.packages.find]
40
  where = ["src"]