Raymond-dev-546730 commited on
Commit
a836af6
·
verified ·
1 Parent(s): 066a27b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +29 -15
README.md CHANGED
@@ -1,3 +1,7 @@
 
 
 
 
1
  # MaterialsAnalyst-AI-7B
2
 
3
  ![MaterialsAnalyst-AI Logo](Logo.png)
@@ -287,24 +291,36 @@ print(result)
287
  1. **Install dependencies**
288
  ```bash
289
  pip install torch transformers accelerate safetensors
 
 
290
  ```
291
 
292
- 2. **Download the model**
293
- - Option A: Use Hugging Face Hub (automatic download)
294
- - Option B: Clone this repository for local files
 
 
295
 
296
- 3. **Prepare your materials data**
297
- - Format as JSON with material properties
298
- - Include relevant structural, electronic, and mechanical data
299
- - Common sources: Materials Project, AFLOW, DFT calculations, experimental databases
 
 
 
 
 
 
 
300
 
301
- 4. **Run analysis**
302
- - Use the provided scripts in `/Scripts/` folder
303
- - Or integrate the code examples above into your workflow
 
304
 
305
- 5. **Customize your analysis**
306
- - Modify the JSON input with your specific materials data
307
- - Adjust generation parameters (temperature, top_p) for different output styles
308
 
309
  ## License
310
 
@@ -323,6 +339,4 @@ If you use MaterialsAnalyst-AI-7B in your research, please cite:
323
  }
324
  ```
325
 
326
- ---
327
-
328
  **Developed by**: Mike in collaboration with Oregon State University Materials Modeling and Development Group
 
1
+ ---
2
+ license: apache-2.0
3
+ ---
4
+
5
  # MaterialsAnalyst-AI-7B
6
 
7
  ![MaterialsAnalyst-AI Logo](Logo.png)
 
291
  1. **Install dependencies**
292
  ```bash
293
  pip install torch transformers accelerate safetensors
294
+ # For LLaMA.cpp option:
295
+ pip install llama-cpp-python
296
  ```
297
 
298
+ 2. **Clone or download this repository**
299
+ ```bash
300
+ git clone https://huggingface.co/your-username/MaterialsAnalyst-AI-7B
301
+ cd MaterialsAnalyst-AI-7B
302
+ ```
303
 
304
+ 3. **Run the provided scripts**
305
+
306
+ **For SafeTensors deployment:**
307
+ ```bash
308
+ python Scripts/Inference_safetensors.py
309
+ ```
310
+
311
+ **For LLaMA.cpp deployment:**
312
+ ```bash
313
+ python Scripts/Inference_llama.cpp.py
314
+ ```
315
 
316
+ 4. **Customize your analysis**
317
+ - Edit the `JSON_INPUT` variable in either script with your materials data
318
+ - Modify the `model_path` variable to point to your model files
319
+ - Adjust generation parameters as needed
320
 
321
+ 5. **Input your materials data**
322
+ - Replace the example SiC data with your material properties
323
+ - Common sources: Materials Project, AFLOW, DFT calculations, experimental databases
324
 
325
  ## License
326
 
 
339
  }
340
  ```
341
 
 
 
342
  **Developed by**: Mike in collaboration with Oregon State University Materials Modeling and Development Group