Upload folder using huggingface_hub

README.md

@@ -1,202 +1,191 @@
----
-base_model: unsloth/gemma-2-2b
-library_name: peft
----
-
-# 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.12.0
+# Instruct Evolve Pipeline
+
+## Key Feature
+The pipeline can be used recursively, feeding enhanced tasks and responses back into the model to generate increasingly complex iterations.
+
+Gemma2 2b base model is used for this pipeline at 10,000 context. 
+
+example VLLM run script located in repo as [run_gemma2-2b.sh](./run_gemma2-2b.sh)
+
+example gradio script located in repo as [gradio_gemma2-2b.py](./gradio_gemma2-2b.py)
+
+
+## Overview
+Instruct Evolve is a pipeline that generates increasingly complex tasks and responses for a given Title and Context, using a base model fine-tuned on a specific prompt pipeline.
+
+## Process Flow
+1. Input: Title and Context
+2. Output: Task, Response, Enhanced Task, Enhanced Response
+
+
+## Usage
+Zero-shot the base model with pseudo XML, or start with an existing type, task, and response, and enhance it further.
+
+Input:
+```xml
+<title>Your Title</title>
+<content>
+    Your multi-line content
+</content>
+```
+
+Output:
+```xml
+<type>explanation</type>
+<thinking>Thoughts on task type</thinking>
+<task>Context-aware task</task>
+<thinking>Thoughts on task response</thinking>
+<response>Response to the task</response>
+<thinking>Thoughts on enhancing the task</thinking>
+<enhancedtask>More complex version of the task</enhancedtask>
+<thinking>Thoughts on enhanced task response</thinking>
+<response>Response to the enhanced task</response>
+```
+
+## Supported Task Types
+- Question
+- Explanation
+- Analysis
+- Comparison
+- Application
+
+## Dataset Curation Process
+1. Generate 20k unique subject-context pairs
+2. Generate tasks for each pair
+3. Generate responses for each task
+4. Enhance tasks based on previous responses
+5. Generate responses for enhanced tasks
+6. Repeat enhancement process 3 times
+7. Generate 5500 samples using Gemma2 9b instruct
+8. Clean and format data
+9. Create final dataset
+10. Train model using unsloth/Qwen2.5-3B with specific parameters
+
+
+### Input 
+
+```xml
+<title>Fission Products</title>
+<content>
+  **Category: Thouless Pumping in Nuclear Physics**
+  **Document:**
+  Consider the Thouless pumping effect in a nuclear reactor. This effect is attributed to the presence of a high-energy neutron stream that can interact with a large number of fertile nuclei, inducing fission reactions.
+  **Question:**
+  A nuclear reactor is operating at a criticality level. A high-energy neutron stream passes through the reactor, initiating a large number of fission events. 
+  The neutron stream is depleted due to the absorption of neutrons by the fission products. 
+  Explain how the neutron stream's density and flux are affected by the Thouless pumping mechanism and the subsequent decay of fission products.  
+  **Answer:**
+  The Thouless pumping effect amplifies the neutron stream's density and flux in a nuclear reactor.
+  The high-energy neutron stream induces a cascade of fission reactions, which produce a large number of fission products. These fission products absorb neutrons, resulting in a significant decrease in the neutron density and flux.
+  However, the fission products themselves undergo radioactive decay, releasing energetic particles and gamma rays. These decays continue to replenish the neutron stream, effectively negating the initial depletion.
+  **Reasoning Steps:**
+  1. **Understand the concept of Thouless pumping:** Thouless pumping is a perturbation effect in neutron physics where a strong neutron flow causes a cascade of fission reactions, leading to an increase in neutron density and flux.
+  2. **Analyze the interaction between neutrons and fission products:** When neutrons interact with fission products, they are absorbed by the fission products. This absorption leads to a decrease in the neutron density and flux.
+  3. **Recognize the role of radioactive decay:** Radioactive decay of fission products releases energetic particles and gamma rays. These decays replenish the neutron stream, negating the initial depletion.
+  4. **Consider the long-term impact:** The ongoing decay of fission products maintains a relatively constant neutron density and flux, ensuring the reactor's criticality is maintained.
+  **Key Concepts:**
+  * Thouless pumping
+  * Neutron Physics
+  * Nuclear Fission
+  * Neutron Density
+  * Neutron Flux
+  * Radioactive Decay
+  * Fission Products
+  * Criticality
+  The Thouless pumping mechanism plays a crucial role in enhancing the neutron stream's density and flux in a nuclear reactor. This mechanism is triggered by a high-energy neutron stream, which induces a cascade of fission reactions. As a result, the number of fission products rapidly increases, leading to a significant generation of radioactive isotopes.
+  These fission products are highly neutron-absorbing, and as they accumulate in the reactor, they absorb a substantial amount of neutrons. This absorption causes a sharp decrease in the neutron density and flux within the reactor.
+  However, the decay of these fission products is a critical factor that helps to maintain and even augment the neutron stream. The high-energy fission products decay through various modes, releasing energetic particles such as alpha and beta particles, as well as gamma rays. These decays introduce a continuous supply of neutrons into the reactor system through neutron emission, scintillation of the emitted particles, and other nuclear reactions.
+  In summary, the Thouless pumping mechanism amplifies the neutron stream's density and flux by initiating a cascade of fission reactions. The subsequent decay of fission products releases new neutrons into the reactor, thus counteracting the initial depletion. This process ensures that the neutron density and flux are sustained over the long term. $ \boxed{16} $
+  Reasoning: Let's think step by step in order to understand the effect of Thouless pumping and the decay of fission products on neutron stream density and flux.
+  Explanation:
+  The Thouless pumping mechanism is a phenomenon where a strong input of high-energy neutrons into a reactor leads to a sustained, amplified neutron flux. Here’s a step-by-step breakdown of how this affects neutron stream density and flux, especially considering the decay of fission products:
+  1. **Thouless Pumping Mechanism:**
+     - **Input of High-Energy Neutrons:** The initial high-energy neutron stream, typically from external sources or fission reactions, is directly fed into the reactor.
+     - **Fission Reactions:** These high-energy neutrons induce fission reactions in heavy nuclei, producing a chain of fission events.
+     - **Fission Products:** As a result, a large number of fission products are created, which are highly neutron-absorbing isotopes.
+     - **Neutron Densification:** The generation of many fission products leads to an increase in neutron density inside the reactor.
+  2. **Neutron Stream Density and Flux:**
+     - **Density Increase:** The presence of numerous fission products increases the overall neutron density in the reactor.
+     - **Flux Increase:** The continuous fission reactions create a high rate of neutron production, leading to a higher neutron flux.
+     - **Pumping Effect:** The accumulated fission products maintain a positive feedback loop, as their presence ensures a continuous influx of neutrons, further increasing the neutron density and flux.
+  3. **Decay of Fission Products:**
+     - **Neutron Release:** When the fission products decay, they release additional neutrons. This is because the decay processes themselves produce additional energetic particles and γ-rays.
+     - **Neutron Emission:** These decaying fission products can undergo various decay modes that release neutrons, such as alpha decay, beta decay, and γ-decay.
+     - **Replenishment of Ne The Thouless pumping mechanism plays a crucial role in enhancing the neutron stream's density and flux in a nuclear reactor. This mechanism is triggered by a high-energy neutron stream, which induces a cascade of fission reactions. As a result, the number of fission products rapidly increases, leading to a significant generation of radioactive isotopes.
+  These fission products are highly neutron-absorbing, and as they accumulate in the reactor, they absorb a substantial amount of neutrons. This absorption causes a sharp decrease in the neutron density and flux within the reactor.
+  However, the decay of these fission products is a critical factor that helps to maintain and even augment the neutron stream. The high-energy fission products decay through various modes, releasing energetic particles such as alpha and beta particles, as well as gamma rays. These decays introduce a continuous supply of neutrons into the reactor system through neutron emission, scintillation of the emitted particles, and other nuclear reactions.
+  In summary, the Thouless pumping mechanism amplifies the neutron stream's density and flux by initiating a cascade of fission reactions. The subsequent decay of fission products releases new neutrons into the reactor, thus counteracting the initial depletion. This process ensures that the neutron density and flux are sustained over the long term. $ \boxed{16} $
+  Reasoning: Let's think step by step in order to understand the effect of Thouless pumping and the decay of fission products on neutron stream density and flux.
+  Explanation:
+  The Thouless pumping mechanism is a phenomenon where a strong input of high-energy neutrons into a reactor leads to a sustained, amplified neutron flux. Here’s a step-by-step breakdown of how this affects neutron stream density and flux, especially considering the decay of fission products:
+  1. **Thouless Pumping Mechanism:**
+     - **Input of High-Energy Neutrons:** The initial high-energy neutron stream, typically from external sources or fission reactions, is directly fed into the reactor.
+     - **Fission Reactions:** These high-energy neutrons induce fission reactions in heavy nuclei, producing a chain of fission events.
+     - **Fission Products:** As a result, a large number of fission products are created, which are highly neutron-absorbing isotopes.
+     - **Neutron Densification:** The generation of many fission products leads to an increase in neutron density inside the reactor.
+  2. **Neutron Stream Density and Flux:**
+     - **Density Increase:** The presence of numerous fission products increases the overall neutron density in the reactor.
+     - **Flux Increase:** The continuous fission reactions create a high rate of neutron production, leading to a higher neutron flux.
+     - **Pumping Effect:** The accumulated fission products maintain a positive feedback loop, as their presence ensures a continuous influx of neutrons, further increasing the neutron density and flux.
+  3. **Decay of Fission Products:**
+     - **Neutron Release:** When the fission products decay, they release additional neutrons. This is because the decay processes themselves produce additional energetic particles and γ-rays.
+     - **Neutron Emission:** These decaying fission products can undergo various decay modes that release neutrons, such as alpha decay, beta decay, and γ-decay.
+     - **Replenishment of Ne
+</content>
+```
+
+###  Output 
+
+```xml
+<type>explanation</type>
+<thinking> To compare the effects of Thouless pumping and the decay of fission products on neutron stream density and flux, we need to analyze their individual contributions and how they interact. </thinking>
+<task> Compare and contrast the effects of the Thouless pumping mechanism and the decay of fission products on the density and flux of neutrons within a nuclear reactor. Discuss how these two phenomena work together to maintain a sustained neutron stream. </task>
+<thinking>
+  Both the Thouless pumping mechanism and the decay of fission products contribute to maintaining a sustained neutron stream in a nuclear reactor, but they do so through distinct processes. 
+  Thouless pumping amplifies the neutron flux by creating a positive feedback loop. The initial high-energy neutron stream triggers a cascade of fission reactions, producing more neutrons. These newly produced neutrons further induce fission, leading to a rapid increase in neutron density and flux.
+  Fission product decay, on the other hand, replenishes the neutron stream by releasing neutrons during the radioactive decay process. While fission products absorb neutrons, their decay releases a continuous supply of neutrons back into the reactor core, counteracting the absorption and ensuring a sustained neutron population.
+</thinking>
+<response>
+  The Thouless pumping mechanism and the decay of fission products are two crucial factors that work together to maintain a sustained neutron stream in a nuclear reactor.
+  **Thouless Pumping:**
+  * **Mechanism:** A high-energy neutron stream triggers a cascade of fission reactions, leading to a rapid increase in neutron density and flux.
+  * **Effect:** Amplifies the neutron stream by creating a positive feedback loop.
+  * **Key Feature:**  Driven by the initial input of high-energy neutrons and the chain reaction of fission.
+  **Decay of Fission Products:**
+  * **Mechanism:** Radioactive decay of fission products releases neutrons as part of the decay process.
+  * **Effect:** Replenishes the neutron stream, counteracting the absorption by fission products.
+  * **Key Feature:** A continuous process that provides a steady supply of neutrons over time.
+  **Working Together:**
+  Thouless pumping initially creates a surge in neutron density and flux, while the decay of fission products provides a continuous source of neutrons to sustain the chain reaction. This interplay ensures that the reactor core maintains a critical state, with a sufficient neutron population to sustain fission reactions and generate power.
+  **In essence:** Thouless pumping provides the initial boost, and fission product decay acts as the sustainer, keeping the neutron stream flowing and the reactor operating.
+</response>
+<thinking>
+  The previous response provides a good basic understanding of Thouless pumping and fission product decay. However, it could be enhanced by:
+  * **Deeper Dive into Decay Modes:**  Elaborating on the specific decay modes (alpha, beta, gamma) and how they contribute to neutron release would add depth.
+  * **Neutron Absorption Cross-Sections:**  Mentioning the concept of neutron absorption cross-sections for different fission products would highlight the varying degrees of neutron absorption.
+  * **Reactor Control:**  Discussing how reactor control mechanisms (e.g., control rods) are used to manage the neutron population in relation to Thouless pumping and fission product decay would provide a more complete picture.
+</thinking>
+<enhancedtask> Investigate the specific roles of alpha, beta, and gamma decay in releasing neutrons from fission products.  How do the neutron absorption cross-sections of different fission products influence the overall neutron density and flux in a reactor?  Explain how reactor control mechanisms, such as control rods, are used to manage the neutron population in the context of Thouless pumping and fission product decay. </enhancedtask>
+<thinking>
+  Here's a breakdown of the roles of alpha, beta, and gamma decay in neutron release, the impact of fission product cross-sections, and how control rods manage neutron populations in a reactor:
+  **Alpha, Beta, and Gamma Decay and Neutron Release:**
+  * **Alpha Decay:** Alpha particles are essentially helium nuclei (two protons and two neutrons). While alpha decay releases energy, it doesn't directly produce neutrons.
+  * **Beta Decay:** Beta decay involves the transformation of a neutron into a proton (beta-minus decay) or a proton into a neutron (beta-plus decay).  
+      * **Beta-minus decay:**  A neutron decays into a proton, emitting an electron (beta particle) and an antineutrino. This process can sometimes result in the emission of a neutron.
+      * **Beta-plus decay:** A proton decays into a neutron, emitting a positron (antielectron) and a neutrino. This process does not directly produce neutrons.
+  * **Gamma Decay:** Gamma decay involves the release of high-energy photons (gamma rays) from an excited nucleus. While gamma rays can interact with matter and potentially induce fission, they don't directly produce neutrons.
+  **Neutron Absorption Cross-Sections:**
+  * **Cross-Section:** The neutron absorption cross-section of a nucleus is a measure of its probability of absorbing a neutron. 
+  * **Fission Product Variation:** Different fission products have vastly different neutron absorption cross-sections. Some are highly neutron-absorbing (e.g., xenon isotopes), while others are less so.
+  * **Impact on Neutron Density and Flux:** The abundance and neutron absorption cross-sections of fission products directly influence the neutron density and flux in a reactor. High neutron absorption by fission products can lead to a decrease in neutron population, potentially causing the reactor to become subcritical.
+  **Reactor Control Mechanisms (Control Rods):**
+  * **Purpose:** Control rods are made of materials with very high neutron absorption cross-sections (e.g., boron, cadmium). They are inserted into the reactor core to absorb excess neutrons and regulate the chain reaction.
+  * **Thouless Pumping and Control:** In the context of Thouless pumping, control rods are crucial for managing the amplified neutron flux. They prevent the reactor from becoming supercritical and potentially leading to a runaway chain reaction.
+  * **Operation:** By adjusting the position of control rods, operators can fine-tune the neutron population in the reactor. Inserting rods further into the core increases neutron absorption, slowing down the chain reaction. Withdrawing rods allows more neutrons to participate in fission, increasing the reactor power.
+</thinking>
+<response>
+  The decay of fission products plays a crucial role in the neutron population dynamics of a nuclear reactor, particularly in the context of Thouless pumping. While alpha decay does not directly release neutrons, beta decay can sometimes result in neutron emission. Gamma decay, while not directly producing neutrons, can contribute to neutron production through interactions with matter.
+  The neutron absorption cross-sections of different fission products significantly influence the overall neutron density and flux. Highly neutron-absorbing fission products, such as xenon isotopes, can lead to a decrease in neutron population, potentially causing the reactor to become subcritical.
+  Reactor control mechanisms, such as control rods, are essential for managing the neutron population in the context of Thouless pumping and fission product decay. Control rods, made of materials with high neutron absorption cross-sections, are inserted into the reactor core to absorb excess neutrons and regulate the chain reaction. By adjusting the position of control rods, operators can fine-tune the neutron population, preventing the reactor from becoming supercritical and ensuring safe and controlled operation.
+</response>
+```

gradio_gemma2-2b.py

@@ -0,0 +1,97 @@
+import gradio as gr
+import requests
+import re
+import html
+import traceback
+import logging
+
+# Set up logging
+logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
+
+VLLM_URL = "http://localhost:6002/v1/completions"
+MODEL = "lora"
+
+def flexible_parse(text):
+    pattern = r'<(\w+)(?:\s+[^>]*)?>((?:(?!<\1).)*?)</\1>|<(\w+)(?:\s+[^>]*)?>'
+    result = []
+    
+    for match in re.finditer(pattern, text):
+        tag, content, single_tag = match.groups()
+        if single_tag:
+            result.append((single_tag, ''))
+        elif tag:
+            result.append((tag, content.strip() if content else ''))
+    
+    return result
+
+def format_as_collapsible_markdown(parsed_content):
+    markdown = ""
+    for tag, content in parsed_content:
+        if content:
+            markdown += f'<details>\n<summary><strong>{html.escape(tag)}</strong></summary>\n\n{html.escape(content)}\n\n</details>\n\n'
+        else:
+            markdown += f'<strong>{html.escape(tag)}</strong>\n\n'
+    return markdown
+
+def get_completion(title: str, prompt: str):
+    full_prompt = f"<title>{title}</title>\n<content>\n{prompt}\n</content>"
+    try:
+        logging.info(f"Sending request to VLLM server: {VLLM_URL}")
+        response = requests.post(
+            VLLM_URL,
+            json={
+                "prompt": full_prompt,
+                "max_tokens": 6000,
+                "temperature": 1,
+                "model": MODEL
+            },
+            timeout=30000  # Add a timeout
+        )
+        response.raise_for_status()  # Raise an exception for bad status codes
+        logging.info("Successfully received response from VLLM server")
+        return response.json()["choices"][0]["text"]
+    except requests.exceptions.RequestException as e:
+        logging.error(f"Error connecting to VLLM server: {str(e)}")
+        return f"Error connecting to VLLM server: {str(e)}"
+    except Exception as e:
+        logging.error(f"Unexpected error in get_completion: {str(e)}")
+        return f"Unexpected error: {str(e)}\n{traceback.format_exc()}"
+
+def gradio_interface(title, prompt):
+    try:
+        logging.info(f"Received request - Title: {title}, Prompt: {prompt}")
+        raw_response = get_completion(title, prompt)
+        parsed_content = flexible_parse(raw_response)
+        collapsible_view = format_as_collapsible_markdown(parsed_content)
+        
+        combined_output = f"""
+## Raw Response:
+
+```
+{raw_response}
+```
+
+## Parsed Structure:
+
+{collapsible_view}
+"""
+        logging.info("Successfully processed request")
+        return combined_output
+    except Exception as e:
+        logging.error(f"Error in gradio_interface: {str(e)}")
+        return f"Error in gradio_interface: {str(e)}\n{traceback.format_exc()}"
+
+iface = gr.Interface(
+    fn=gradio_interface,
+    inputs=[
+        gr.Textbox(label="Title"),
+        gr.Textbox(label="Prompt", lines=5)
+    ],
+    outputs=gr.Markdown(label="Response and Parsed Structure"),
+    title="VLLM Completion Client with Raw Response and Collapsible View",
+    description=f"Enter a title and prompt to generate a completion using the {MODEL} model. The raw response and a collapsible view of the parsed structure will be displayed."
+)
+
+if __name__ == "__main__":
+    logging.info("Starting Gradio interface")
+    iface.launch()