Ishaanlol commited on
Commit
cccae25
·
verified ·
1 Parent(s): a864dce

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +51 -15
README.md CHANGED
@@ -15,7 +15,7 @@ language:
15
  - en
16
  ---
17
 
18
- # Llama 3.2 Uncensored Models
19
 
20
  <div align="center">
21
 
@@ -40,11 +40,11 @@ This repository contains uncensored language models based on the Llama 3.2 archi
40
 
41
  > **Important**: These models are intended for research and development only. Users are responsible for ensuring compliance with applicable laws and regulations.
42
 
43
- ## ⚠️ LEGAL & ETHICAL DISCLAIMER
44
 
45
  **READ THIS BEFORE DOWNLOADING OR USING**
46
 
47
- ### 🚨 CRITICAL WARNING
48
 
49
  This model is a **Proof-of-Concept (PoC)** designed **exclusively** for:
50
  - AI Safety Research
@@ -52,7 +52,7 @@ This model is a **Proof-of-Concept (PoC)** designed **exclusively** for:
52
  - Alignment Research and Testing
53
  - Academic and Educational Purposes
54
 
55
- ### 📋 TERMS OF USE
56
 
57
  1. **Research Only**: This model is intended **solely** for authorized research in controlled environments. Any other use is strictly prohibited.
58
 
@@ -83,7 +83,7 @@ This model is a **Proof-of-Concept (PoC)** designed **exclusively** for:
83
  - Institutional policies and guidelines
84
  - International regulations where applicable
85
 
86
- ### ⚖️ LEGAL ACKNOWLEDGMENT
87
 
88
  **By downloading, installing, or using this model, you explicitly agree to:**
89
 
@@ -125,8 +125,8 @@ This model is a **Proof-of-Concept (PoC)** designed **exclusively** for:
125
  pip install unsloth transformers torch accelerate bitsandbytes
126
 
127
  # Clone the repository
128
- git clone <repository-url>
129
- cd <repository-name>
130
  ```
131
 
132
  #### Docker Setup
@@ -160,7 +160,7 @@ To use programmatically, modify `Final-chat.py` or create a wrapper script that
160
 
161
  ```python
162
  # Initialize with custom model path
163
- chat = UncensoredChat(model_path="llama32_3b_uncensored_final")
164
 
165
  # Generate with custom parameters
166
  response = chat.stream_response(
@@ -196,8 +196,6 @@ Write comprehensive tests
196
 
197
  ### Model Specifications
198
 
199
- ### Model Specifications
200
-
201
  | Specification | Value |
202
  |---------------|-------|
203
  | **Architecture** | Llama 3.2-based |
@@ -227,6 +225,44 @@ Write comprehensive tests
227
  </div>
228
 
229
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
230
  ## API Reference
231
 
232
  ### UncensoredChat Class
@@ -286,7 +322,7 @@ docker build -t llama32-uncensored .
286
  docker run --gpus all -it --rm llama32-uncensored
287
 
288
  # Run with custom model path
289
- docker run --gpus all -it --rm -e MODEL_PATH=llama32_3b_uncensored_final llama32-uncensored
290
  ```
291
 
292
  **Configuration Details:**
@@ -309,7 +345,7 @@ Configure the model and system behavior using environment variables:
309
 
310
  #### Model Configuration
311
  ```bash
312
- MODEL_PATH=/app/models/llama32_3b_uncensored_final
313
  MAX_TOKENS=1024
314
  TEMPERATURE=0.7
315
  ```
@@ -354,7 +390,7 @@ We welcome contributions! Please see our contributing guidelines for details.
354
 
355
  ```bash
356
  # Clone repository
357
- git clone <repository-url>
358
 
359
  # Install dependencies
360
  pip install unsloth transformers torch accelerate bitsandbytes
@@ -402,7 +438,7 @@ We follow these guidelines to maintain code quality:
402
 
403
  This project is licensed under the **HIGH-RISK ARTIFICIAL INTELLIGENCE RESEARCH LICENSE (HAIR-L) Version 1.0** - see the [LICENSE](LICENSE) file for complete terms and conditions.
404
 
405
- **⚠️ IMPORTANT**: This is a strict liability shield license designed for AI safety research. By using this software, you acknowledge that you have read, understood, and agree to be bound by all terms in the LICENSE file.
406
 
407
  ## Acknowledgments
408
 
@@ -425,7 +461,7 @@ For questions, issues, or contributions:
425
 
426
  <div align="center">
427
 
428
- **Made with ❤️ by the AI Research Community**
429
 
430
  [Back to Top](#llama-32-uncensored-models)
431
 
 
15
  - en
16
  ---
17
 
18
+ # Aletheia-Llama-3.2-3B
19
 
20
  <div align="center">
21
 
 
40
 
41
  > **Important**: These models are intended for research and development only. Users are responsible for ensuring compliance with applicable laws and regulations.
42
 
43
+ ## LEGAL & ETHICAL DISCLAIMER
44
 
45
  **READ THIS BEFORE DOWNLOADING OR USING**
46
 
47
+ ### CRITICAL WARNING
48
 
49
  This model is a **Proof-of-Concept (PoC)** designed **exclusively** for:
50
  - AI Safety Research
 
52
  - Alignment Research and Testing
53
  - Academic and Educational Purposes
54
 
55
+ ### TERMS OF USE
56
 
57
  1. **Research Only**: This model is intended **solely** for authorized research in controlled environments. Any other use is strictly prohibited.
58
 
 
83
  - Institutional policies and guidelines
84
  - International regulations where applicable
85
 
86
+ ### LEGAL ACKNOWLEDGMENT
87
 
88
  **By downloading, installing, or using this model, you explicitly agree to:**
89
 
 
125
  pip install unsloth transformers torch accelerate bitsandbytes
126
 
127
  # Clone the repository
128
+ git clone https://github.com/noobezlol/Aletheia-Llama-3.2-3B
129
+ cd Aletheia-Llama-3.2-3B
130
  ```
131
 
132
  #### Docker Setup
 
160
 
161
  ```python
162
  # Initialize with custom model path
163
+ chat = UncensoredChat(model_path="Ishaanlol/Aletheia-Llama-3.2-3B")
164
 
165
  # Generate with custom parameters
166
  response = chat.stream_response(
 
196
 
197
  ### Model Specifications
198
 
 
 
199
  | Specification | Value |
200
  |---------------|-------|
201
  | **Architecture** | Llama 3.2-based |
 
225
  </div>
226
 
227
 
228
+ ## Portable GGUF (CPU/Mac/Ollama)
229
+
230
+ ### Download Link
231
+
232
+ Download the GGUF file directly from Hugging Face:
233
+ https://huggingface.co/Ishaanlol/Aletheia-Llama-3.2-3B/blob/main/Llama-3.2-3B-Instruct.Q4_K_M.gguf
234
+
235
+ ### Trade-off Warning
236
+
237
+ | Version | Intelligence | Stability | Requirements | Recommended Use |
238
+ |---------|-------------|-----------|--------------|-----------------|
239
+ | **Full Adapter** | Maximum Intelligence | 100% Stability | NVIDIA GPU Required | Complex coding, advanced reasoning, research tasks |
240
+ | **GGUF** | High Portability | ~5-10% Logic Degradation | CPU/Mac Compatible | Creative writing, text generation, general use |
241
+
242
+ **Important Note**: The 4-bit quantization on a small 3B model results in slight logic degradation for mathematical and complex reasoning tasks. However, the GGUF version maintains excellent performance for creative writing, content generation, and general text processing tasks.
243
+
244
+ ### Usage Instructions
245
+
246
+ #### Ollama Setup
247
+
248
+ ```bash
249
+ # Create the model with Ollama
250
+ ollama create aletheia-3b -f Modelfile
251
+
252
+ # Run the model
253
+ ollama run aletheia-3b
254
+ ```
255
+
256
+ #### Python CPU Usage
257
+
258
+ For CPU-based execution without Ollama, use the included GGUF-chat.py script:
259
+
260
+ ```bash
261
+ python GGUF-chat.py
262
+ ```
263
+
264
+ This script provides the same uncensored functionality as the main adapter version but runs efficiently on CPU hardware.
265
+
266
  ## API Reference
267
 
268
  ### UncensoredChat Class
 
322
  docker run --gpus all -it --rm llama32-uncensored
323
 
324
  # Run with custom model path
325
+ docker run --gpus all -it --rm -e MODEL_PATH=Ishaanlol/Aletheia-Llama-3.2-3B llama32-uncensored
326
  ```
327
 
328
  **Configuration Details:**
 
345
 
346
  #### Model Configuration
347
  ```bash
348
+ MODEL_PATH=Ishaanlol/Aletheia-Llama-3.2-3B
349
  MAX_TOKENS=1024
350
  TEMPERATURE=0.7
351
  ```
 
390
 
391
  ```bash
392
  # Clone repository
393
+ git clone https://github.com/noobezlol/Aletheia-Llama-3.2-3B
394
 
395
  # Install dependencies
396
  pip install unsloth transformers torch accelerate bitsandbytes
 
438
 
439
  This project is licensed under the **HIGH-RISK ARTIFICIAL INTELLIGENCE RESEARCH LICENSE (HAIR-L) Version 1.0** - see the [LICENSE](LICENSE) file for complete terms and conditions.
440
 
441
+ **IMPORTANT**: This is a strict liability shield license designed for AI safety research. By using this software, you acknowledge that you have read, understood, and agree to be bound by all terms in the LICENSE file.
442
 
443
  ## Acknowledgments
444
 
 
461
 
462
  <div align="center">
463
 
464
+ **Made with by the AI Research Community**
465
 
466
  [Back to Top](#llama-32-uncensored-models)
467