Kaynaaf commited on
Commit
d5505d6
·
verified ·
1 Parent(s): d343fa1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -74
README.md CHANGED
@@ -16,95 +16,25 @@ tags:
16
  An Image Classifier that predicts the presence of certain Brain tumours from their MRI scans
17
 
18
  ## Model Details
19
- A ConVNet trained on ~130M Parameters
20
- ### Model Description
21
-
22
- <!-- Provide a longer summary of what this model is. -->
23
-
24
-
25
-
26
- - **Developed by:** [More Information Needed]
27
- - **Funded by [optional]:** [More Information Needed]
28
- - **Shared by [optional]:** [More Information Needed]
29
- - **Model type:** [More Information Needed]
30
- - **Language(s) (NLP):** [More Information Needed]
31
- - **License:** [More Information Needed]
32
- - **Finetuned from model [optional]:** [More Information Needed]
33
-
34
- ### Model Sources [optional]
35
-
36
- <!-- Provide the basic links for the model. -->
37
-
38
- - **Repository:** [More Information Needed]
39
- - **Paper [optional]:** [More Information Needed]
40
- - **Demo [optional]:** [More Information Needed]
41
 
42
  ## Uses
43
 
44
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
45
 
46
  ### Direct Use
47
 
48
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
49
-
50
- [More Information Needed]
51
-
52
- ### Downstream Use [optional]
53
-
54
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
55
-
56
- [More Information Needed]
57
-
58
- ### Out-of-Scope Use
59
 
60
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
61
 
62
- [More Information Needed]
63
-
64
- ## Bias, Risks, and Limitations
65
-
66
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
67
-
68
- [More Information Needed]
69
 
70
- ### Recommendations
71
-
72
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
73
 
74
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
75
 
76
  ## How to Get Started with the Model
77
 
78
- Use the code below to get started with the model.
79
-
80
- [More Information Needed]
81
-
82
- ## Training Details
83
-
84
- ### Training Data
85
-
86
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
87
-
88
- [More Information Needed]
89
-
90
- ### Training Procedure
91
 
92
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
93
 
94
- #### Preprocessing [optional]
95
-
96
- [More Information Needed]
97
-
98
-
99
- #### Training Hyperparameters
100
-
101
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
102
-
103
- #### Speeds, Sizes, Times [optional]
104
-
105
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
106
-
107
- [More Information Needed]
108
 
109
  ## Evaluation
110
 
 
16
  An Image Classifier that predicts the presence of certain Brain tumours from their MRI scans
17
 
18
  ## Model Details
19
+ A 134M Parameter ConvNet designed for classification of Brain tumours in MRI scans.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
20
 
21
  ## Uses
22
 
 
23
 
24
  ### Direct Use
25
 
26
+ Load the model, finetune the model if needed or just go straight towards generating inferences using the model.
 
 
 
 
 
 
 
 
 
 
27
 
 
28
 
 
 
 
 
 
 
 
29
 
30
+ ### Downstream Use [optional]
 
 
31
 
32
+ Finetune the model on other diagnostic scans, though the model only accepts grayscale images of size 256x256.
33
 
34
  ## How to Get Started with the Model
35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
 
 
37
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
38
 
39
  ## Evaluation
40