Skip to content

Commit 740ebe1

Browse files
authored
Updated scripts README
Removed template format
1 parent 1f24f0c commit 740ebe1

1 file changed

Lines changed: 1 addition & 30 deletions

File tree

scripts/README.md

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,6 @@ Scripts should be executed by running DVC stages from the root of the NOMELT rep
44

55
These are the scripts used to prepare data, train the model, evaluate the model, use it to engineer ENH1, and run it zero-shot on experimental data.
66

7-
## Script Name: [Script_Name]
8-
9-
### Description
10-
- Brief description of what the script does.
11-
12-
### Input Files
13-
- [Input_File_1]: Description of input file 1.
14-
- [Input_File_2]: Description of input file 2.
15-
- ...
16-
17-
### Output Files
18-
- [Output_File_1]: Description of output file 1.
19-
- [Output_File_2]: Description of output file 2.
20-
- ...
21-
22-
### Plots Generated
23-
- [Plot_1]: Description of plot 1.
24-
- [Plot_2]: Description of plot 2.
25-
- ...
26-
27-
### Parameters
28-
- [Parameter_1]: Current value - [Value], Description.
29-
- [Parameter_2]: Current value - [Value], Description.
30-
- ...
31-
32-
### Additional Notes
33-
- Any other relevant information about the script.
34-
35-
367
## Script Name: prepare_data.py
378

389
### Description
@@ -405,4 +376,4 @@ These are not part of the linear pipeline to train, evaluated, and use the model
405376
- `./scripts/proof_of_principle/check_training_set_for_case_studies.py`: Script to check for specific proteins in the training dataset.
406377

407378
### Output Files
408-
- `./data/enh/training_data_homologs.json`: JSON file containing the e-values of any hits found in the training set, relevant to the case study proteins.
379+
- `./data/enh/training_data_homologs.json`: JSON file containing the e-values of any hits found in the training set, relevant to the case study proteins.

0 commit comments

Comments
 (0)