kalsy commited on
Commit
f2a964b
·
verified ·
1 Parent(s): ee4f56c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +11 -54
README.md CHANGED
@@ -53,70 +53,27 @@ Using the model output by the learning mechanism and the binary file (.dat) outp
53
 
54
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
55
 
56
- ### Direct Use
57
-
58
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
59
-
60
- [More Information Needed]
61
-
62
- ### Downstream Use [optional]
63
-
64
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
65
-
66
- [More Information Needed]
67
-
68
- ### Out-of-Scope Use
69
-
70
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
71
-
72
- [More Information Needed]
73
-
74
- ## Bias, Risks, and Limitations
75
-
76
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
77
-
78
- [More Information Needed]
79
-
80
- ### Recommendations
81
-
82
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
83
-
84
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
85
-
86
  ## How to Get Started with the Model
87
 
88
- Use the code below to get started with the model.
89
-
90
- [More Information Needed]
91
-
92
- ## Training Details
93
-
94
- ### Training Data
95
-
96
- <!-- 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. -->
97
-
98
- [More Information Needed]
99
-
100
- ### Training Procedure
101
-
102
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
103
-
104
- #### Preprocessing [optional]
105
 
106
- [More Information Needed]
107
 
 
 
 
 
 
108
 
109
- #### Training Hyperparameters
110
 
111
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
112
 
113
- #### Speeds, Sizes, Times [optional]
114
 
115
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
116
 
117
- [More Information Needed]
118
 
119
- ## Evaluation
120
 
121
  <!-- This section describes the evaluation protocols and provides the results. -->
122
 
 
53
 
54
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
55
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
  ## How to Get Started with the Model
57
 
58
+ ./build/main train_model model_dir data_dir save_dir --verbose --model model_name
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
59
 
60
+ Replace:
61
 
62
+ model_dir with the path to the directory containing the model
63
+ data_dir with the dataset path
64
+ save_dir with the directory where the trained model should be saved
65
+ model_name with the specific model architecture to be used (e.g., convlstm).
66
+ The --verbose flag enables detailed logging.
67
 
68
+ Run example
69
 
70
+ ./build/main tezip --learn model/ data/ --verbose --model convlstm
71
 
 
72
 
73
+ ## Evaluation
74
 
 
75
 
76
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/667233cdcbf550c42aeb6bb5/JQjtMvkBVtKvcT7bfCKlu.png)
77
 
78
  <!-- This section describes the evaluation protocols and provides the results. -->
79