Update README.md

README.md

@@ -1,202 +1,96 @@
 ---
-base_model: unsloth/mistral-small-instruct-2409-bnb-4bit
+base_model:
+- mistralai/Mistral-Small-Instruct-2409
 library_name: peft
+datasets:
+- kejian/arxiv-physics-debug-v0
 ---
 
-# Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
-
-
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
-### Framework versions
-
-- PEFT 0.13.2
+# Mistral Physics Fine-tuned Model
+
+This model is a fine-tuned version of [mistralai/Mistral-Small-Instruct-2409](https://huggingface.co/mistralai/Mistral-Small-Instruct-2409) on [kejian/arxiv-physics-debug-v0](https://huggingface.co/datasets/kejian/arxiv-physics-debug-v0). Mostly for concept proofing, don't trust it for real physics (I mean, even Claude 3.5 can be wrong on graduate physics plenty of times, let alone a 22B model, but this hould perform a lot better than [benhaotang/llama3.2-1B-physics-finetuned](https://huggingface.co/benhaotang/llama3.2-1B-physics-finetuned))!
+
+Sorry for not having F16 version, there is no way to fit everything into VRAM or RAM at the same time in my current configuration.
+
+## Model description
+- Base model: [mistralai/Mistral-Small-Instruct-2409](https://huggingface.co/mistralai/Mistral-Small-Instruct-2409)
+- Training data: [kejian/arxiv-physics-debug-v0](https://huggingface.co/datasets/kejian/arxiv-physics-debug-v0)
+- Fine-tuning type: LoRA
+- Use case: Physics domain questions
+- Training Arguments:
+  - Learning Rate: 2e-5
+  - Epochs: 3
+  - Gradient Accumulation Steps: 8
+- Training setup: Colab with Nvidia L4
+
+## Usage
+```python
+from transformers import AutoModelForCausalLM, BitsAndBytesConfig
+import torch
+bnb_config = BitsAndBytesConfig(
+    load_in_8bit=False,
+    llm_int8_enable_fp32_cpu_offload=True
+)
+model = AutoModelForCausalLM.from_pretrained(
+    "benhaotang/mistral-small-physics-finetuned-bnb-4bit",
+    device_map="auto",
+    torch_dtype=torch.float16,
+    offload_folder="offload_folder",
+    quantization_config=bnb_config
+)
+tokenizer = AutoTokenizer.from_pretrained("benhaotang/mistral-small-physics-finetuned-bnb-4bit")
+
+# Example usage
+text = "Give me a short intodcution to renormalization group(RG) flow in physcis?\n"
+inputs = tokenizer(text, return_tensors="pt").to("cuda")
+outputs = model.generate(**inputs, max_length=2048)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
+
+Example output:
+
+> The Renormalization Group (RG) flow is a fundamental concept in physics, particularly in the study of phase transitions and critical phenomena. It describes how the behavior of a system changes with scale, such as the size of the system or the length scale of fluctuations. Here's a brief introduction:
+> 
+> 1. **Scale Dependence**: Many physical systems exhibit properties that depend on the scale at which they are observed. For example, a fluid might appear smooth on a large scale but exhibit turbulent behavior on a small scale.
+> 
+> 2. **RG Transformation**: The RG flow involves a transformation that systematically integrates out short-distance fluctuations to obtain an effective theory that describes the system at longer distances. This is often done by progressively eliminating high-momentum modes in the system.
+> 
+> 3. **Fixed Points and Universality**: The RG flow can lead to fixed points, which are scale-invariant solutions. Systems that flow to the same fixed point under RG transformation exhibit universal behavior, meaning their large-scale properties are the same regardless of the details of the system at small scales.
+> 
+> 4. **Relevant and Irrelevant Operators**: In the vicinity of a fixed point, operators can be classified as relevant (grow under RG flow), irrelevant (shrink), or marginal (remain constant). Relevant operators drive the system away from the fixed point, while irrelevant ones become negligible at large scales.
+> 
+> 5. **Applications**: RG flow is crucial in understanding critical phenomena, such as phase transitions in statistical mechanics, and has applications in condensed matter physics, quantum field theory, and even in areas like biology and computer science.
+> 
+> In essence, RG flow helps us understand how the microscopic details of a system influence its macroscopic behavior, and how universal properties emerge from complex systems.
+
+### Training
+
+| Step | Training Loss | Validation Loss |
+|:----:|:-------------:|:---------------:|
+| 50   | 2.407400      | 1.798349        |
+| 100  | 1.452000      | 1.765856        |
+| 150  | 1.161300      | 1.716366        |
+| 200  | 1.223700      | 1.704631        |
+| 250  | 1.135900      | 1.683653        |
+| 300  | 1.371900      | 1.677721        |
+| 350  | 1.208500      | 1.657915        |
+| 400  | 1.303400      | 1.657678        |
+| 450  | 1.233700      | 1.642972        |
+| 500  | 1.081900      | 1.653393        |
+| 550  | 1.117700      | 1.645338        |
+| 600  | 1.109500      | 1.651868        |
+| 650  | 1.190100      | 1.689853        |
+| 700  | 1.000000      | 1.663633        |
+| 750  | 1.020100      | 1.647308        |
+| 800  | 1.033400      | 1.675173        |
+| 850  | 1.082300      | 1.652737        |
+| 900  | 1.074000      | 1.665859        |
+| 950  | 0.975300      | 1.661394        |
+| 1000 | 0.955000      | 1.672116        |
+| 1050 | 1.017000      | 1.656730        |
+| 1100 | 0.941500      | 1.652197        |
+| 1150 | 1.003100      | 1.657381        |
+| 1200 | 0.891100      | 1.662021        |
+| 1250 | 0.931000      | 1.662401        |
+| 1300 | 0.932800      | 1.662421        |
+| 1350 | 1.042000      | 1.665535        |