ONNX
josh-gregory commited on
Commit
c0bb35a
·
verified ·
1 Parent(s): 4353e12

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -27
README.md CHANGED
@@ -74,35 +74,28 @@ All models were trained in bf16 mixed precision and were tuned for 24 hours on a
74
 
75
  ## Evaluation
76
 
77
- <!-- This section describes the evaluation protocols and provides the results. -->
78
-
79
- ### Testing Data, Factors & Metrics
80
-
81
- #### Testing Data
82
 
83
  <!-- This should link to a Dataset Card if possible. -->
84
 
85
  Refer to the Dataset card to find the relevant testing data, as different kinds exist.
86
 
87
- #### Metrics
88
-
89
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
90
-
91
- [More Information Needed]
92
-
93
- ### Results
94
-
95
- The ResNet-50 and ResNet-152 architectures were found to work the best for our task, as they were the only two that were able to generalize between the augmented training data and the un-augmented validation data.
96
 
97
  #### Summary
98
 
99
  The `base` directory contains all trained models with base hyperparameters. The `tuned` directory contains the models after hyperparameter tuning. The `hyperparameters` folder itself contains each model's tuned hyperparameters in a JSON file, and the `inference_examples` directory contains examples for how to inference our models in safetensors format.
100
 
101
- ## Model Examination [optional]
102
 
103
- <!-- Relevant interpretability work for the model goes here -->
104
 
105
- [More Information Needed]
 
 
 
 
 
 
106
 
107
  ## Environmental Impact
108
 
@@ -144,16 +137,6 @@ All models were written in PyTorch Lightning.
144
 
145
  [More Information Needed]
146
 
147
- ## Glossary [optional]
148
-
149
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
150
-
151
- [More Information Needed]
152
-
153
- ## More Information [optional]
154
-
155
- [More Information Needed]
156
-
157
  ## Model Card Authors
158
 
159
  Josh Gregory
 
74
 
75
  ## Evaluation
76
 
77
+ ### Testing Data
 
 
 
 
78
 
79
  <!-- This should link to a Dataset Card if possible. -->
80
 
81
  Refer to the Dataset card to find the relevant testing data, as different kinds exist.
82
 
 
 
 
 
 
 
 
 
 
83
 
84
  #### Summary
85
 
86
  The `base` directory contains all trained models with base hyperparameters. The `tuned` directory contains the models after hyperparameter tuning. The `hyperparameters` folder itself contains each model's tuned hyperparameters in a JSON file, and the `inference_examples` directory contains examples for how to inference our models in safetensors format.
87
 
88
+ ## Model Examination
89
 
90
+ For all models the Captum library was used to aid in explainability of all models. For the MLP models, the following explainability algorithms were used:
91
 
92
+ - GradientSHAP
93
+ - DeepLIFT
94
+ - Feature ablation
95
+
96
+ For the CNN architectures, the GradCAM algorithm was used to create a heatmap of areas the model used to create its permeability estimate.
97
+
98
+ For more details and results, refer to the paper.
99
 
100
  ## Environmental Impact
101
 
 
137
 
138
  [More Information Needed]
139
 
 
 
 
 
 
 
 
 
 
 
140
  ## Model Card Authors
141
 
142
  Josh Gregory