yaojialzc commited on
Commit
dabf1d4
1 Parent(s): 6efb9bb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +57 -1
README.md CHANGED
@@ -3,4 +3,60 @@ license: apache-2.0
3
  language:
4
  - en
5
  - zh
6
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  language:
4
  - en
5
  - zh
6
+ ---
7
+ # Model Details
8
+ - name: Gigi-Llama-3-en-zh
9
+ - version: 1.0.0
10
+ - type: <Specify the model type>
11
+ - training_date: <YYYY-MM-DD>
12
+
13
+ # Authors & Organization
14
+ - authors: <Your Name>
15
+ - organization: <Your Organization>
16
+
17
+ # Intended Use
18
+ - primary_uses: <Primary use cases>
19
+ - primary_users: <Primary intended users>
20
+ - out_of_scope_use_cases: <Use cases that the model is not suitable for>
21
+
22
+ # Data
23
+ - datasets: <Names and references to the datasets used>
24
+ - preprocessing: <Details of data preprocessing>
25
+
26
+ # Evaluation
27
+ - metrics: <Metrics used to evaluate model performance>
28
+ - results: <Performance results on evaluation metrics>
29
+
30
+ # Performance
31
+ - performance_summary: <Summary of the model performance>
32
+ - subgroup_performance: <Performance on different demographic or interest-based subgroups if applicable>
33
+
34
+ # Fairness & Bias
35
+ - bias_evaluation: <Assessment of model biases>
36
+ - mitigation_strategies: <Strategies used to mitigate biases>
37
+
38
+ # Robustness
39
+ - robustness_evaluation: <Tests for model robustness>
40
+ - known_limitations: <Known limitations regarding robustness>
41
+
42
+ # Limitations
43
+ - general_limitations: <General limitations of the model>
44
+ - risks: <Potential risks of using the model>
45
+
46
+ # Copyright & Licensing
47
+ - copyright: <Your Copyright Statement>
48
+ - license_details: apache-2.0
49
+
50
+ # References
51
+ - papers: <Relevant research papers>
52
+ - articles: <Relevant articles>
53
+
54
+ # Additional Information
55
+ - contact_information: <Your contact information>
56
+ - update_history: <History of model updates>
57
+ - acknowledgements: <People or organizations to acknowledge>
58
+ ---
59
+
60
+ # Commit your changes
61
+ - commit_message: <Describe the changes made>
62
+ - branch: main