Rustamshry commited on
Commit
1325f7c
·
verified ·
1 Parent(s): 1ff9e74

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +53 -162
README.md CHANGED
@@ -1,7 +1,7 @@
1
  ---
2
  base_model: unsloth/Qwen2.5-1.5B-Instruct
3
  library_name: peft
4
- pipeline_tag: text-generation
5
  tags:
6
  - base_model:adapter:unsloth/Qwen2.5-1.5B-Instruct
7
  - lora
@@ -9,202 +9,93 @@ tags:
9
  - transformers
10
  - trl
11
  - unsloth
 
 
 
 
 
12
  ---
13
 
14
  # Model Card for Model ID
15
 
16
- <!-- Provide a quick summary of what the model is/does. -->
17
-
18
 
19
 
20
  ## Model Details
21
 
22
  ### Model Description
23
 
24
- <!-- Provide a longer summary of what this model is. -->
25
-
26
-
27
-
28
- - **Developed by:** [More Information Needed]
29
- - **Funded by [optional]:** [More Information Needed]
30
- - **Shared by [optional]:** [More Information Needed]
31
- - **Model type:** [More Information Needed]
32
- - **Language(s) (NLP):** [More Information Needed]
33
- - **License:** [More Information Needed]
34
- - **Finetuned from model [optional]:** [More Information Needed]
35
-
36
- ### Model Sources [optional]
37
-
38
- <!-- Provide the basic links for the model. -->
39
-
40
- - **Repository:** [More Information Needed]
41
- - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
43
 
 
44
  ## Uses
45
 
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
-
48
  ### Direct Use
49
 
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
-
52
- [More Information Needed]
53
-
54
- ### Downstream Use [optional]
55
-
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
59
-
60
- ### Out-of-Scope Use
61
-
62
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
-
64
- [More Information Needed]
65
 
66
  ## Bias, Risks, and Limitations
67
 
68
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
69
-
70
- [More Information Needed]
71
-
72
- ### Recommendations
73
-
74
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
75
 
76
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
77
 
78
  ## How to Get Started with the Model
79
 
80
- Use the code below to get started with the model.
81
-
82
- [More Information Needed]
83
-
84
- ## Training Details
85
-
86
- ### Training Data
87
-
88
- <!-- 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. -->
89
-
90
- [More Information Needed]
91
-
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
-
100
-
101
- #### Training Hyperparameters
102
-
103
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
-
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
-
111
- ## Evaluation
112
 
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
 
115
- ### Testing Data, Factors & Metrics
 
 
 
 
116
 
117
- #### Testing Data
118
 
119
- <!-- This should link to a Dataset Card if possible. -->
120
 
121
- [More Information Needed]
 
 
122
 
123
- #### Factors
 
 
 
 
 
 
 
124
 
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
 
 
 
 
126
 
127
- [More Information Needed]
128
 
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
-
135
- ### Results
136
-
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
-
142
-
143
- ## Model Examination [optional]
144
-
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
-
149
- ## Environmental Impact
150
-
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
152
-
153
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
154
-
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
-
161
- ## Technical Specifications [optional]
162
-
163
- ### Model Architecture and Objective
164
-
165
- [More Information Needed]
166
-
167
- ### Compute Infrastructure
168
-
169
- [More Information Needed]
170
-
171
- #### Hardware
172
-
173
- [More Information Needed]
174
-
175
- #### Software
176
-
177
- [More Information Needed]
178
-
179
- ## Citation [optional]
180
-
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
182
-
183
- **BibTeX:**
184
-
185
- [More Information Needed]
186
-
187
- **APA:**
188
-
189
- [More Information Needed]
190
-
191
- ## Glossary [optional]
192
-
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
194
-
195
- [More Information Needed]
196
-
197
- ## More Information [optional]
198
-
199
- [More Information Needed]
200
 
201
- ## Model Card Authors [optional]
202
 
203
- [More Information Needed]
 
204
 
205
- ## Model Card Contact
206
 
207
- [More Information Needed]
208
  ### Framework versions
209
 
210
  - PEFT 0.17.0
 
1
  ---
2
  base_model: unsloth/Qwen2.5-1.5B-Instruct
3
  library_name: peft
4
+ pipeline_tag: question-answering
5
  tags:
6
  - base_model:adapter:unsloth/Qwen2.5-1.5B-Instruct
7
  - lora
 
9
  - transformers
10
  - trl
11
  - unsloth
12
+ license: mit
13
+ datasets:
14
+ - Heigke/stanford-enigma-philosophy-chat
15
+ language:
16
+ - en
17
  ---
18
 
19
  # Model Card for Model ID
20
 
21
+ Stanford-philosophy is a fine-tuned version of Qwen2.5-1.5B-Instruct, trained specifically on philosophical texts. The model specializes in understanding and generating responses related to complex philosophical concepts, arguments, and debates.
 
22
 
23
 
24
  ## Model Details
25
 
26
  ### Model Description
27
 
28
+ - **Language:** English
29
+ - **License:** MIT
30
+ - **Finetuned from model:** unsloth/Qwen2.5-1.5B-Instruct
31
+ - **Fine-Tuning Method**: Supervised Fine-tuning with LoRA
32
+ - **Domain**: Philosophy
33
+ - **Dataset**: Heigke/stanford-enigma-philosophy-chat
 
 
 
 
 
 
 
 
 
 
 
 
 
34
 
35
+
36
  ## Uses
37
 
 
 
38
  ### Direct Use
39
 
40
+ - Generating clear and concise explanations of philosophical concepts.
41
+ - Providing structured responses to philosophical questions.
42
+ - Assisting students, researchers, and enthusiasts in exploring philosophical arguments.
 
 
 
 
 
 
 
 
 
 
 
 
43
 
44
  ## Bias, Risks, and Limitations
45
 
46
+ - While fine-tuned on philosophy, the model may still occasionally generate hallucinations or less precise interpretations of highly nuanced philosophical arguments.
47
+ - The model does not replace expert human philosophical judgment.
 
 
 
 
 
48
 
 
49
 
50
  ## How to Get Started with the Model
51
 
52
+ ```
53
+ from huggingface_hub import login
54
+ from transformers import AutoTokenizer, AutoModelForCausalLM
55
+ from peft import PeftModel
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
 
57
+ login(token="")
58
 
59
+ tokenizer = AutoTokenizer.from_pretrained("unsloth/Qwen2.5-1.5B-Instruct",)
60
+ base_model = AutoModelForCausalLM.from_pretrained(
61
+ "unsloth/Qwen2.5-1.5B-Instruct",
62
+ device_map={"": 0}, token=""
63
+ )
64
 
65
+ model = PeftModel.from_pretrained(base_model,"Rustamshry/Stanford-philosophy")
66
 
67
+ question = "According to William Whewell, what is necessary for gaining knowledge?"
68
 
69
+ system = """
70
+ You are an expert in philosophy.
71
+ """
72
 
73
+ messages = [
74
+ {"role" : "system", "content" : system},
75
+ {"role" : "user", "content" : question}
76
+ ]
77
+ text = tokenizer.apply_chat_template(
78
+ messages,
79
+ tokenize = False,
80
+ )
81
 
82
+ from transformers import TextStreamer
83
+ _ = model.generate(
84
+ **tokenizer(text, return_tensors = "pt").to("cuda"),
85
+ max_new_tokens = 1024,
86
+ streamer = TextStreamer(tokenizer, skip_prompt = True),
87
+ )
88
 
89
+ ```
90
 
91
+ ## Training Details
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
92
 
93
+ ### Training Data
94
 
95
+ Roughly 27k questions and answers inspired by articles from Stanford Encyclopedia of Philosophy.
96
+ The questions range all the way from Zombies to the concept of Abduction, from Metaphysics to Neuroethics and thus cover some of the essence of mathematics, logic and philosophy.
97
 
 
98
 
 
99
  ### Framework versions
100
 
101
  - PEFT 0.17.0