pzweuj commited on
Commit
937dec3
·
verified ·
1 Parent(s): 9b60e63

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +35 -42
README.md CHANGED
@@ -1,61 +1,54 @@
1
  ---
2
  language:
3
- - en
 
4
  tags:
5
- - biology
6
- - ESM
7
- - language-model
8
- - protein
9
- - VEP
10
- pretty_name: EVOScore-2
11
- size_categories:
12
- - 100M<n<1B
13
- license: mit
14
  ---
15
 
16
- # Proteome-wide VESM-3B Variant Effect Scores (MIT Clean Mirror)
17
 
18
- ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
19
- ![Commercial Status](https://img.shields.io/badge/Status-Commercial--Safe-brightgreen)
20
 
21
- ## ⚠️ Compliance & Mirror Notice
22
 
23
- This repository is a **strict subset** of the original [ntranoslab/vesm_scores](https://huggingface.co/datasets/ntranoslab/vesm_scores).
24
 
25
- To ensure commercial compliance and safety, all non-commercial components (VESM3, Sequence-only VESM3, and VESM++) have been **permanently removed** from this mirror.
26
 
27
- **This repository contains ONLY the `VESM_3B` predictions**, which are based on the ESM2-3B architecture and explicitly released under the MIT License.
 
 
 
28
 
29
- ---
30
-
31
- ## Dataset Description
32
-
33
- This repository provides precomputed **proteome-wide (UniProtKB, hg19, and hg38) variant-effect prediction scores** using the **VESM_3B** model.
34
-
35
- ### Included Model
36
- * **VESM_3B:** A protein language model based on **ESM2 (3B parameter)** architecture.
37
 
38
- *(Note: The original VESM3 and VESM++ models based on ESM3 have been excluded from this repository).*
39
 
40
- For more scientific details, please refer to the original GitHub repo: https://github.com/ntranoslab/vesm
41
 
42
- ## Files Included
43
- * `hg38_VESM_3B_scores.parquet.gzip`
44
- * `hg19_VESM_3B_scores.parquet.gzip`
45
- * `hg38_VESM_3B_scores.vcf.gz`
46
- * `hg19_VESM_3B_scores.vcf.gz`
47
- * *(And any other Uniprot/metadata files strictly related to VESM_3B)*
48
 
49
- ## Threshold Recommend
50
 
51
- | P_threshold | <-11.6 |
52
- | --------------- | ----------- |
53
- | **B_threshold** | **>-8.5** |
54
 
55
- ## License <a name="license"></a>
 
 
 
 
 
 
 
 
 
 
56
 
57
- The data provided in this repository is distributed under the **MIT License**.
58
 
59
- > **Attribution:**
60
- > This dataset is a mirror of the VESM_3B predictions generated by Ntranos Lab.
61
- > While the original repository contained mixed licenses, the content hosted here is exclusively sourced from the MIT-licensed portion.
 
1
  ---
2
  language:
3
+ - en
4
+ license: other
5
  tags:
6
+ - biology
7
+ - genomics
8
+ - medical
9
+ - bioinformatics
10
+ - variant-annotation
11
+ - clinical
12
+ - wgs
13
+ - wes
14
+ pretty_name: SchemaBio Bundle
15
  ---
16
 
17
+ # 🧬 SchemaBio Bundle
18
 
19
+ ## 📖 Overview
20
+ This dataset is a comprehensive, meticulously curated, one-stop annotation library designed for bioinformatics and genomic variant analysis (e.g., WES/WGS pipelines). It aggregates essential variant effect predictors, clinical databases, and genomic reference files into a unified repository, significantly reducing the time spent on data collection, format alignment, and preprocessing.
21
 
 
22
 
 
23
 
24
+ ## 🗂️ Included Data & Sources
25
 
26
+ This repository includes data from the following categories:
27
+ 1. **Variant Effect Predictors & Scores:** AlphaMissense, EVOScore2, Pangolin.
28
+ 2. **Clinical & Population Frequencies:** gnomAD, CIViC, mskcc_hotspot.
29
+ 3. **Genomic References & Regions:** UCSC annotations (`cytoband`, `ncbiRefSeq.gtf`), Ensembl references (`GRCh38/37 FASTA`, `vep_cache`), ManeSelectBed.
30
 
 
 
 
 
 
 
 
 
31
 
 
32
 
33
+ ## ⚖️ Licensing & Commercial Use
34
 
35
+ **Great news: All underlying datasets included in this repository currently permit commercial use**, provided that users strictly adhere to their respective attribution and share-alike requirements.
 
 
 
 
 
36
 
37
+ Because this repository acts as an aggregator, **it does not fall under a single license**. You must comply with the individual licenses of the respective underlying data sources. The table below outlines the specific license for each component:
38
 
39
+ ### 📊 Database Licenses Summary
 
 
40
 
41
+ | Database / Source | Version | Official License | Commercial Use | Redistribution | Key Requirements & Notes |
42
+ | :--- | :--- | :--- | :--- | :--- | :--- |
43
+ | [**AlphaMissense**](https://zenodo.org/records/10813168) | v3 | **CC BY 4.0** | ✅ Allowed | ✅ Allowed | Must attribute to DeepMind Technologies Limited. |
44
+ | [**EVOScore2**](https://huggingface.co/datasets/pzweuj/EVOScore-2) | 20260128 | **MIT** | ✅ Allowed | ✅ Allowed | Must include the original copyright notice. |
45
+ | [**Pangolin**](https://zenodo.org/records/15649338) | v1 | **CC BY 4.0** | ✅ Allowed | ✅ Allowed | Must provide proper attribution. |
46
+ | [**ManeSelectBed**](https://github.com/pzweuj/ManeSelectBed) | v49 | **MIT** | ✅ Allowed | ✅ Allowed | Must include the original copyright notice. |
47
+ | [**mskcc_hotspot**](https://www.cancerhotspots.org/) | v2 | **ODbL** | ✅ Allowed | ✅ Allowed | **Share-Alike:** If you modify/adapt this database, the derivative must also be ODbL. |
48
+ | [**CIViC**](https://civicdb.org/welcome) | 20260301 | **CC0 1.0** | ✅ Allowed | ✅ Allowed | Public Domain. No restrictions. |
49
+ | [**gnomAD**](https://gnomad.broadinstitute.org/) | v4.1 | **Unrestricted** | ✅ Allowed | ✅ Allowed | Broad Institute claims no restrictions on use. |
50
+ | [**UCSC Data**](https://hgdownload.soe.ucsc.edu/goldenPath) | / | **Public Domain** | ✅ Allowed | ✅ Allowed | Publicly funded data, free for all uses. |
51
+ | [**Ensembl Data**](https://ftp.ensembl.org/pub/release-115/) | release 115 | **Unrestricted** | ✅ Allowed | ✅ Allowed | EMBL-EBI places no restrictions on use or redistribution. |
52
 
53
+ *Disclaimer: The creator of this combined dataset claims no ownership over the original source data. Users are solely responsible for ensuring their downstream use complies with the original data providers' terms.*
54