NeuralNovel commited on
Commit
7c1ed83
1 Parent(s): 2af6ff4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +132 -0
README.md CHANGED
@@ -1,3 +1,135 @@
1
  ---
2
  license: apache-2.0
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
  ---
4
+
5
+ # NeuralNovel/Mistral-7B-Instruct-v0.2-Neural-Story
6
+
7
+ <!-- Provide a quick summary of what the model is/does. -->
8
+
9
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
10
+
11
+ ## Model Details
12
+
13
+ ### Model Description
14
+
15
+ <!-- Provide a longer summary of what this model is. -->
16
+
17
+
18
+
19
+ - **Developed by:** NeuralNovel
20
+ - **Funded by Techmind**
21
+
22
+ - **License:** apache-2.0
23
+ - **Finetuned from Mistral-7B-Instruct-v0.2 :** [https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2]
24
+
25
+ ## Uses
26
+
27
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
28
+
29
+ ### Direct Use
30
+
31
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
32
+
33
+ [More Information Needed]
34
+
35
+ ### Downstream Use [optional]
36
+
37
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
38
+
39
+ [More Information Needed]
40
+
41
+ ### Out-of-Scope Use
42
+
43
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
44
+
45
+ [More Information Needed]
46
+
47
+ ## Bias, Risks, and Limitations
48
+
49
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
50
+
51
+ [More Information Needed]
52
+
53
+ ### Recommendations
54
+
55
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
56
+
57
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
58
+
59
+ ## How to Get Started with the Model
60
+
61
+ Use the code below to get started with the model.
62
+
63
+ [More Information Needed]
64
+
65
+ ## Training Details
66
+
67
+ ### Training Data
68
+
69
+ <!-- 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. -->
70
+
71
+ [More Information Needed]
72
+
73
+ ### Training Procedure
74
+
75
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
76
+
77
+ #### Preprocessing [optional]
78
+
79
+ [More Information Needed]
80
+
81
+
82
+ #### Training Hyperparameters
83
+
84
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
85
+
86
+ #### Speeds, Sizes, Times [optional]
87
+
88
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
89
+
90
+ [More Information Needed]
91
+
92
+ ## Evaluation
93
+
94
+ <!-- This section describes the evaluation protocols and provides the results. -->
95
+
96
+ ### Testing Data, Factors & Metrics
97
+
98
+ #### Testing Data
99
+
100
+ <!-- This should link to a Dataset Card if possible. -->
101
+
102
+ [More Information Needed]
103
+
104
+ #### Factors
105
+
106
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
107
+
108
+ [More Information Needed]
109
+
110
+ #### Metrics
111
+
112
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
113
+
114
+ [More Information Needed]
115
+
116
+ ### Results
117
+
118
+ [More Information Needed]
119
+
120
+ #### Summary
121
+
122
+
123
+ #### Hardware
124
+
125
+ Trained using NVIDIA Tesla T40 24 GB.
126
+
127
+
128
+ n_epochs = 3,
129
+ n_checkpoints = 3,
130
+ batch_size = 12,
131
+ learning_rate = 1e-5,
132
+
133
+
134
+
135
+