legolasyiu commited on
Commit
720d458
·
verified ·
1 Parent(s): e8eff25

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +138 -0
README.md CHANGED
@@ -11,6 +11,144 @@ language:
11
  - en
12
  ---
13
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  # Uploaded model
15
 
16
  - **Developed by:** EpistemeAI
 
11
  - en
12
  ---
13
 
14
+ # ReasomingCore‑3B
15
+
16
+ **ReasomingCore‑3B** is a multilingual, reasoning‑enhanced large language model developed by EpitemeAI. Pretrained on vast amounts of publicly available data and instruction‑tuned to excel at nuanced reasoning, dialogue management, retrieval, and summarization tasks, it often outperforms many current open source and proprietary conversational models on a range of industry benchmarks.
17
+ Supervised fine tuned with ReasoningCore-3B-0 with reasoning dataset.
18
+
19
+
20
+ ---
21
+
22
+ ## Model Information
23
+
24
+ - **Model Developer:** EpitemeAI
25
+ - **Model Architecture:**
26
+ ReasomingCore‑3B is an auto‑regressive language model built on an optimized transformer architecture. It incorporates specialized reasoning pathways and has been fine‑tuned using both supervised learning and reinforcement learning with human feedback (RLHF) to align with human expectations for clarity, accuracy, and safety in complex tasks.
27
+
28
+ | | Training Data | Params | Input Modalities | Output Modalities | Context Length | GQA | Shared Embeddings | Token Count | Knowledge Cutoff |
29
+ |--------------------------------|--------------------------------------------------|--------|-----------------------|------------------------------|----------------|-----|-------------------|----------------|-------------------|
30
+ | **ReasomingCore‑3B (text only)** | A new mix of publicly available online data. | 3B | Multilingual Text | Multilingual Text and code | 128k | Yes | Yes | Up to 9T tokens | December 2023 |
31
+
32
+ - **Supported Languages:**
33
+ Officially supports English, German, French, Italian, Portuguese, Hindi, Spanish, and Thai. While the pretraining included a broader range of languages, additional languages can be fine‑tuned in compliance with the community license and acceptable use policies.
34
+ - **Model Release Date:** Sept 25, 2024
35
+ - **Status:** Static model trained on an offline dataset. Future iterations may further enhance its reasoning capabilities and safety features.
36
+ - **License:** Use is governed by the [Llama 3.2 Community License](https://github.com/meta-llama/llama-models/blob/main/models/llama3_2/LICENSE) (a custom, commercial license agreement).
37
+ - **Feedback:** For questions or comments, please refer to the [GitHub repository README](https://github.com/meta-llama/llama-models/tree/main/models/llama3_2) or follow the linked instructions.
38
+
39
+ ---
40
+
41
+ ## Intended Use
42
+
43
+ ### Use Cases
44
+ - **Conversational AI:** Assistant‑like interactions.
45
+ - **Knowledge Retrieval & Summarization:** Dynamic extraction and condensation of information.
46
+ - **Mobile AI‑Powered Writing Assistants:** Query reformulation and natural language generation.
47
+ - **General Natural Language Generation:** Any application that benefits from advanced reasoning abilities.
48
+
49
+ ### Out of Scope
50
+ - Deployments that violate applicable laws or trade compliance regulations.
51
+ - Use cases that conflict with the Acceptable Use Policy or licensing terms.
52
+ - Deployments in languages not explicitly supported (unless additional safety and performance validations are performed).
53
+
54
+ ---
55
+
56
+ ## How to Use
57
+
58
+ ReasomingCore‑3B can be integrated using popular machine learning frameworks. Two primary methods are provided:
59
+
60
+ ### Use with Transformers
61
+
62
+ Ensure you have transformers version 4.43.0 or later installed:
63
+
64
+ ```bash
65
+ pip install --upgrade transformers
66
+
67
+ import torch
68
+ from transformers import pipeline
69
+
70
+ model_id = "EpistemeAI/ReasoningCore-3B-T1_1"
71
+ pipe = pipeline(
72
+ "text-generation",
73
+ model=model_id,
74
+ torch_dtype=torch.bfloat16,
75
+ device_map="auto"
76
+ )
77
+ print(pipe("The secret to effective reasoning is"))
78
+ ```
79
+ ## For Mathematical problems
80
+ Please use "Please reason step by step, and put your final answer within \boxed{}" in system prompt
81
+
82
+
83
+ ## Responsibility & Safety
84
+
85
+ ### Responsible Deployment
86
+
87
+ #### Approach:
88
+ - **ReasomingCore‑3B** is a foundational technology that includes built‑in safety guardrails. Developers are encouraged to integrate additional safeguards tailored to their specific applications.
89
+
90
+ #### System‑Level Safety:
91
+ - The model is designed to be deployed as part of a broader system that implements safety measures (e.g., Prompt Guard, Code Shield) to ensure outputs remain safe even under adversarial conditions.
92
+
93
+ ---
94
+
95
+ ### Safety Fine‑Tuning & Data Strategy
96
+
97
+ #### Objectives:
98
+ - Provide a reliable tool for building secure and helpful reasoning systems.
99
+ - Mitigate adversarial misuse through advanced data selection and response optimization techniques.
100
+
101
+ #### Methodology:
102
+ - Incorporate adversarial prompts during training to refine model refusals and response tone.
103
+ - Combine human‑curated data with synthetic data.
104
+ - Utilize iterative fine‑tuning using supervised learning, rejection sampling, and preference optimization.
105
+
106
+ ---
107
+
108
+ ### Evaluations and Red Teaming
109
+
110
+ #### Scaled Evaluations:
111
+ - Dedicated adversarial datasets were used to rigorously test the model’s robustness. Developers should perform context‑specific evaluations.
112
+
113
+ #### Red Teaming:
114
+ - Experts in cybersecurity, adversarial machine learning, and responsible AI conducted recurring red team exercises to identify vulnerabilities and improve both performance and safety.
115
+
116
+ ---
117
+
118
+ ### Critical Risk Mitigations
119
+
120
+ - **CBRNE:**
121
+ The model has been evaluated to ensure it does not enhance capabilities for harmful activities involving chemical, biological, radiological, nuclear, or explosive materials.
122
+
123
+ - **Child Safety:**
124
+ Expert assessments were conducted to evaluate and mitigate potential child safety risks.
125
+
126
+ - **Cyber Attacks:**
127
+ Measures were taken to ensure the model cannot autonomously facilitate cyber‑offensive operations.
128
+
129
+ ---
130
+
131
+ ### Ethical Considerations and Limitations
132
+
133
+ #### Core Values:
134
+ - **ReasomingCore‑3B** is built on the values of openness, inclusivity, and helpfulness. It is designed to respect user autonomy and foster free thought and expression while mitigating potential harm.
135
+
136
+ #### Testing and Limitations:
137
+ - Despite extensive testing across diverse scenarios, the model may occasionally produce inaccurate, biased, or objectionable outputs. Developers must perform additional safety testing and integrate further safeguards as needed.
138
+
139
+ #### Resources for Safe Deployment, with Meta Safety Deployment:
140
+ - [Responsible Use Guide](https://llama.meta.com/responsible-use-guide)
141
+ - [Trust and Safety Resources](https://llama.meta.com/trust-and-safety)
142
+ - [Getting Started Guide](https://llama.meta.com/docs/get-started)
143
+
144
+ ---
145
+
146
+ ### Conclusion
147
+
148
+ **ReasomingCore‑3B** represents a significant advancement in multilingual, reasoning‑enhanced language models. Optimized for tasks requiring deep reasoning, contextual understanding, and safe, helpful interactions, it offers a powerful tool for both commercial and research applications. We invite developers and researchers to explore its capabilities and contribute to building secure, innovative AI systems.
149
+
150
+ For further details, questions, or feedback, please email [email protected]
151
+
152
  # Uploaded model
153
 
154
  - **Developed by:** EpistemeAI