Gaston895 commited on
Commit
fdb8897
Β·
verified Β·
1 Parent(s): 1fff3cd

Update README with current repository structure

Browse files
Files changed (1) hide show
  1. README.md +24 -18
README.md CHANGED
@@ -44,35 +44,44 @@ This repository contains the Llama 3.3 8B Instruct model with thinking capabilit
44
 
45
  ## Repository Structure
46
 
47
- All model files are located in the root directory for optimal compatibility:
48
 
49
  ```
50
  β”œβ”€β”€ config.json # Model configuration
51
  β”œβ”€β”€ generation_config.json # Generation parameters
52
- β”œβ”€β”€ tokenizer.json # Tokenizer vocabulary
53
  β”œβ”€β”€ tokenizer_config.json # Tokenizer configuration
54
  β”œβ”€β”€ special_tokens_map.json # Special tokens mapping
55
- β”œβ”€β”€ chat_template.jinja # Chat template
56
  β”œβ”€β”€ model.safetensors.index.json # Model index
57
- β”œβ”€β”€ model-00001-of-00004.safetensors # Model weights (part 1)
58
- β”œβ”€β”€ model-00002-of-00004.safetensors # Model weights (part 2)
59
- β”œβ”€β”€ model-00003-of-00004.safetensors # Model weights (part 3)
60
- β”œβ”€β”€ model-00004-of-00004.safetensors # Model weights (part 4)
61
  β”œβ”€β”€ matrix-neo-reloaded-fight.gif # Visual asset
62
- └── README.md # This file
 
 
 
 
 
63
  ```
64
 
65
  ## Usage
66
 
67
- ### Quick Start with Transformers
68
 
69
  ```python
70
  from transformers import AutoTokenizer, AutoModelForCausalLM
71
 
72
- # Load model and tokenizer directly (no subfolder needed)
73
  tokenizer = AutoTokenizer.from_pretrained("Gaston895/aegisconduct")
74
- model = AutoModelForCausalLM.from_pretrained("Gaston895/aegisconduct")
 
 
 
 
 
 
 
75
 
 
76
  # Generate response
77
  inputs = tokenizer("Analyze the economic impact of inflation on consumer spending:", return_tensors="pt")
78
  outputs = model.generate(**inputs, max_length=512, temperature=0.7)
@@ -82,7 +91,7 @@ print(response)
82
 
83
  ### Thinking Mode Activation
84
 
85
- The model automatically activates thinking mode for complex reasoning. Use prompts like:
86
 
87
  ```python
88
  # These prompts will trigger thinking mode
@@ -113,17 +122,14 @@ This model excels at:
113
  - **Global Economics**: International trade, currency analysis
114
  - **Research**: Academic-level economic reasoning and explanation
115
 
116
- ## Example Outputs
117
-
118
- The model provides detailed, step-by-step reasoning for complex economic questions, often showing its "thinking" process before delivering final answers.
119
-
120
  ## Technical Notes
121
 
122
- - All model files are in the root directory for direct loading
 
 
123
  - Supports both instruct and thinking modes
124
  - No system prompt required (thinking tags self-generate)
125
  - Compatible with quantization (Q4KS, IQ3_M recommended minimum)
126
- - Optimized for inference with various backends (transformers, llama.cpp, etc.)
127
 
128
  ## License
129
 
 
44
 
45
  ## Repository Structure
46
 
47
+ Configuration files are in the root directory, with model weights in the econ subdirectory:
48
 
49
  ```
50
  β”œβ”€β”€ config.json # Model configuration
51
  β”œβ”€β”€ generation_config.json # Generation parameters
 
52
  β”œβ”€β”€ tokenizer_config.json # Tokenizer configuration
53
  β”œβ”€β”€ special_tokens_map.json # Special tokens mapping
54
+ β”œβ”€β”€ tokenizer.json # Tokenizer vocabulary
55
  β”œβ”€β”€ model.safetensors.index.json # Model index
56
+ β”œβ”€β”€ chat_template.jinja # Chat template
 
 
 
57
  β”œβ”€β”€ matrix-neo-reloaded-fight.gif # Visual asset
58
+ β”œβ”€β”€ README.md # This file
59
+ └── econ/
60
+ β”œβ”€β”€ model-00001-of-00004.safetensors # Model weights (part 1)
61
+ β”œβ”€β”€ model-00002-of-00004.safetensors # Model weights (part 2)
62
+ β”œβ”€β”€ model-00003-of-00004.safetensors # Model weights (part 3)
63
+ └── model-00004-of-00004.safetensors # Model weights (part 4)
64
  ```
65
 
66
  ## Usage
67
 
68
+ ### Loading the Model
69
 
70
  ```python
71
  from transformers import AutoTokenizer, AutoModelForCausalLM
72
 
73
+ # Method 1: Load with subfolder for model weights
74
  tokenizer = AutoTokenizer.from_pretrained("Gaston895/aegisconduct")
75
+ model = AutoModelForCausalLM.from_pretrained("Gaston895/aegisconduct", subfolder="econ")
76
+
77
+ # Method 2: If all files are at root (after full migration)
78
+ # tokenizer = AutoTokenizer.from_pretrained("Gaston895/aegisconduct")
79
+ # model = AutoModelForCausalLM.from_pretrained("Gaston895/aegisconduct")
80
+ ```
81
+
82
+ ### Generate Response
83
 
84
+ ```python
85
  # Generate response
86
  inputs = tokenizer("Analyze the economic impact of inflation on consumer spending:", return_tensors="pt")
87
  outputs = model.generate(**inputs, max_length=512, temperature=0.7)
 
91
 
92
  ### Thinking Mode Activation
93
 
94
+ The model automatically activates thinking mode for complex reasoning:
95
 
96
  ```python
97
  # These prompts will trigger thinking mode
 
122
  - **Global Economics**: International trade, currency analysis
123
  - **Research**: Academic-level economic reasoning and explanation
124
 
 
 
 
 
125
  ## Technical Notes
126
 
127
+ - Configuration files are at root level for easy access
128
+ - Model weights are in the `econ/` subdirectory
129
+ - Use `subfolder="econ"` when loading model weights
130
  - Supports both instruct and thinking modes
131
  - No system prompt required (thinking tags self-generate)
132
  - Compatible with quantization (Q4KS, IQ3_M recommended minimum)
 
133
 
134
  ## License
135