Update README.md
Browse files
README.md
CHANGED
@@ -59,46 +59,56 @@ hf_pipeline = HuggingFacePipeline(pipeline=generate_code)
|
|
59 |
llm_chain = LLMChain(llm=hf_pipeline, prompt=prompt)
|
60 |
|
61 |
print(llm_chain.predict(instruction="Write a Python function to check if a number is prime."))
|
62 |
-
|
63 |
-
Known Limitations
|
64 |
|
65 |
While Mirror provides high-quality code suggestions, debugging assistance, and structured programming responses, it has the following limitations:
|
66 |
|
67 |
-
General conversation abilities are limited due to its specialization in coding-related tasks.
|
68 |
-
Mathematical reasoning and logical inference may be weaker than models designed for general problem-solving.
|
69 |
-
Complex multi-step reasoning in natural language might require fine-tuning on additional dialogue datasets.
|
70 |
-
|
|
|
|
|
|
|
|
|
|
|
71 |
|
72 |
-
|
|
|
|
|
73 |
|
74 |
-
|
75 |
-
Have limited knowledge of recent programming frameworks or libraries that emerged after its last fine-tuning session.
|
76 |
-
Exhibit hallucinations in open-ended prompts that lack specific instructions.
|
77 |
-
Future Development
|
78 |
|
79 |
-
|
80 |
-
Improving reasoning and debugging capabilities using reinforcement learning from developer interactions.
|
81 |
-
Reducing hallucinations in long-form responses through dataset refinements.
|
82 |
-
License
|
83 |
|
84 |
-
|
|
|
|
|
85 |
|
86 |
-
|
87 |
-
|
88 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
89 |
You may obtain a copy of the License at:
|
90 |
|
91 |
-
π Apache 2.0 License
|
92 |
|
93 |
-
Unless required by applicable law or agreed to in writing, software
|
94 |
-
distributed under the License is distributed on an "AS IS" BASIS,
|
95 |
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
96 |
|
97 |
-
Option 2: Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA 4.0)
|
98 |
-
This model's outputs (such as generated text) and non-code content are licensed under CC-BY-SA 4.0
|
99 |
|
100 |
Under this license:
|
101 |
|
102 |
-
You must give credit when using or sharing outputs.
|
103 |
-
You must share modifications under the same license
|
104 |
-
|
|
|
|
59 |
llm_chain = LLMChain(llm=hf_pipeline, prompt=prompt)
|
60 |
|
61 |
print(llm_chain.predict(instruction="Write a Python function to check if a number is prime."))
|
62 |
+
```
|
63 |
+
## **Known Limitations**
|
64 |
|
65 |
While Mirror provides high-quality code suggestions, debugging assistance, and structured programming responses, it has the following limitations:
|
66 |
|
67 |
+
- **General conversation abilities** are limited due to its specialization in coding-related tasks.
|
68 |
+
- **Mathematical reasoning and logical inference** may be weaker than models designed for general problem-solving.
|
69 |
+
- **Complex multi-step reasoning** in natural language might require fine-tuning on additional dialogue datasets.
|
70 |
+
|
71 |
+
---
|
72 |
+
|
73 |
+
## **Dataset Limitations**
|
74 |
+
|
75 |
+
Mirror is fine-tuned on the **GPT CodeFeedback dataset**, which primarily focuses on **code optimization and structured feedback**. While it provides strong performance for technical queries, it may:
|
76 |
|
77 |
+
- Reflect biases inherent in **publicly available programming datasets**.
|
78 |
+
- Have **limited knowledge of recent programming frameworks or libraries** that emerged after its last fine-tuning session.
|
79 |
+
- Exhibit **hallucinations** in open-ended prompts that lack specific instructions.
|
80 |
|
81 |
+
---
|
|
|
|
|
|
|
82 |
|
83 |
+
## **Future Development**
|
|
|
|
|
|
|
84 |
|
85 |
+
- **Enhancing conversational abilities** by fine-tuning on instruction-heavy dialogue datasets (e.g., OpenAssistant, Dolly).
|
86 |
+
- **Improving reasoning and debugging capabilities** using reinforcement learning from developer interactions.
|
87 |
+
- **Reducing hallucinations in long-form responses** through dataset refinements.
|
88 |
|
89 |
+
---
|
90 |
+
|
91 |
+
## **License**
|
92 |
+
|
93 |
+
Mirror is released under the **Apache License 2.0** and **CC-BY-SA 4.0**, allowing for both **commercial and research usage**.
|
94 |
+
|
95 |
+
### **Option 1: Apache License 2.0**
|
96 |
+
Mirror is licensed under the **Apache License, Version 2.0** (the "License");
|
97 |
+
you may not use this model except in compliance with the License.
|
98 |
You may obtain a copy of the License at:
|
99 |
|
100 |
+
π **[Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0)**
|
101 |
|
102 |
+
Unless required by applicable law or agreed to in writing, software
|
103 |
+
distributed under the License is distributed on an "AS IS" BASIS,
|
104 |
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
105 |
|
106 |
+
### **Option 2: Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA 4.0)**
|
107 |
+
This model's outputs (such as generated text) and non-code content are licensed under **CC-BY-SA 4.0**.
|
108 |
|
109 |
Under this license:
|
110 |
|
111 |
+
- You **must give credit** when using or sharing outputs.
|
112 |
+
- You **must share modifications under the same license**.
|
113 |
+
|
114 |
+
π **[CC-BY-SA 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/)**
|