jjgarciac commited on
Commit
7170c8c
·
verified ·
1 Parent(s): 4b2e962

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -5
README.md CHANGED
@@ -110,7 +110,7 @@ processed-data/
110
  Note: `percentage` is the parameter passed for the percentage of the data to use for training; in this case, `percentage = 80`.
111
 
112
  ### Data Instances
113
- Percentage is the proportion of data that will be used for training (i.e. data_{percentage}p_TRAINING.tsv.gz). In case the percentage is smaller than 100, the remaining proportion of the dataset is stored in data{percentage}p_ALL_NON_TRAIN.tsv.gz and a subset of this in data_{percentage}p_NON_OVERLAP.tsv.gz. Each of this files corresponds to a
114
 
115
  <!--
116
  Describe data files
@@ -120,7 +120,7 @@ Ex: All images are named <img_id>.png, each within a folder named for the specie
120
 
121
  ### Data Fields
122
 
123
- **data_{percentage}p_TRAINING.tsv.gz**: [ADD SUMMARY HERE + descriptions of columns below]
124
  - `id_1`: Phenoscape identifier for trait 1
125
  - `id_2`: Phenoscape identifier for trait 2
126
  - `maxIC`: Ontology-based similarity measure
@@ -132,12 +132,11 @@ Ex: All images are named <img_id>.png, each within a folder named for the specie
132
  - `character_2`: Varying character for trait 2
133
  - `desc_2`: Textual trait description 2
134
 
135
- Note: (`id_1`, `character_1`, `desc_1`) are not fixed.
136
 
137
  ### Data Splits
 
138
 
139
- - Train: `data_{percentage}p_TRAINING.tsv.gz`
140
- - Test: `data_{percentage}p_NON_OVERLAP.tsv.gz`
141
 
142
  ## Dataset Creation
143
 
 
110
  Note: `percentage` is the parameter passed for the percentage of the data to use for training; in this case, `percentage = 80`.
111
 
112
  ### Data Instances
113
+ Percentage is the proportion of data that will be used for training (i.e. data_{percentage}p_TRAINING.tsv.gz). In case the percentage is smaller than 100, the remaining proportion of the dataset is stored in data{percentage}p_ALL_NON_TRAIN.tsv.gz and a subset of this in data_{percentage}p_NON_OVERLAP.tsv.gz. All files follow the same structure.
114
 
115
  <!--
116
  Describe data files
 
120
 
121
  ### Data Fields
122
 
123
+ **data_{percentage}p_TRAINING.tsv.gz**: Collection of pairs of trait descriptors (i.e. `desc_1`, `desc_2`) along with corresponding ontology-based similarity metric (i.e. `maxIC`, `jaccard`, `simGIC`). Each pair of trait descriptors has a corresponding pair of identifiers (i.e. `id_1`, `id_2`) in [Phenoscape](https://kb.phenoscape.org/). The columns `character_1` and `character_2` correspond to [evolutionary characters](https://en.wikipedia.org/wiki/Character_evolution) for which the trait descriptions are states. These are used to split the dataset into disjoint train/test sets.
124
  - `id_1`: Phenoscape identifier for trait 1
125
  - `id_2`: Phenoscape identifier for trait 2
126
  - `maxIC`: Ontology-based similarity measure
 
132
  - `character_2`: Varying character for trait 2
133
  - `desc_2`: Textual trait description 2
134
 
135
+ Notes: (`id_1`, `character_1`, `desc_1`) are not fixed; `order` column will be removed in a future version.
136
 
137
  ### Data Splits
138
+ `data_{percentage}p_TRAINING.tsv.gz` is split into a proper training set and a proper testing set in the [train_model.py](https://github.com/Imageomics/char-sim/blob/feature/no-ref/ablations/train_model.py) file.
139
 
 
 
140
 
141
  ## Dataset Creation
142