aerodynamics21
/

StudyPal-LLM-1.0

@@ -1,199 +1,125 @@
 ---
-library_name: transformers
-tags: []
 ---
-# 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. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **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]

 ---
 ---
+  library_name: transformers
+  tags:
+  - education
+  - croatian
+  - qwen2
+  - fine-tuned
+  - study-assistant
+  language:
+  - hr
+  - en
+  license: apache-2.0
+  base_model: Qwen/Qwen2.5-32B-Instruct
+  ---
+  # StudyPal-LLM-1.0
+  A fine-tuned Croatian educational assistant based on Qwen2.5-32B-Instruct, designed to help students with learning and study materials.
+  ## Model Details
+  ### Model Description
+  StudyPal-LLM-1.0 is a large language model fine-tuned specifically for educational purposes in Croatian. The model excels at generating educational content, answering study questions, creating flashcards, and
+  providing learning assistance.
+  - **Developed by:** aerodynamics21
+  - **Model type:** Causal Language Model
+  - **Language(s):** Croatian (primary), English (secondary)
+  - **License:** Apache 2.0
+  - **Finetuned from model:** Qwen/Qwen2.5-32B-Instruct
+  - **Parameters:** 32.8B
+  ### Model Sources
+  - **Repository:** https://huggingface.co/aerodynamics21/StudyPal-LLM-1.0
+  - **Base Model:** https://huggingface.co/Qwen/Qwen2.5-32B-Instruct
+  - **Adapter:** https://huggingface.co/aerodynamics21/StudyPal-LLM-1
+  ## Uses
+  ### Direct Use
+  This model is designed for educational applications:
+  - Generating study materials in Croatian
+  - Creating flashcards and quiz questions
+  - Providing explanations of complex topics
+  - Assisting with homework and learning
+  ### Usage Examples
+  ```python
+  from transformers import AutoModelForCausalLM, AutoTokenizer
+  model = AutoModelForCausalLM.from_pretrained("aerodynamics21/StudyPal-LLM-1.0")
+  tokenizer = AutoTokenizer.from_pretrained("aerodynamics21/StudyPal-LLM-1.0")
+  # Generate educational content
+  prompt = "Objasni koncept fotosinteze:"
+  inputs = tokenizer(prompt, return_tensors="pt")
+  outputs = model.generate(**inputs, max_length=200, temperature=0.7)
+  response = tokenizer.decode(outputs[0], skip_special_tokens=True)
+  API Usage
+  import requests
+  API_URL = "https://api-inference.huggingface.co/models/aerodynamics21/StudyPal-LLM-1.0"
+  headers = {"Authorization": f"Bearer {your_token}"}
+  def query(payload):
+      response = requests.post(API_URL, headers=headers, json=payload)
+      return response.json()
+  output = query({"inputs": "Stvori kviz o hrvatskoj povijesti:"})
+  Training Details
+  Training Data
+  The model was fine-tuned on a Croatian educational dataset containing:
+  - Educational conversations and Q&A pairs
+  - Flashcard datasets
+  - Quiz and summary materials
+  - Croatian academic content
+  Training Procedure
+  - Base Model: Qwen2.5-32B-Instruct
+  - Training Method: LoRA (Low-Rank Adaptation)
+  - Training Framework: Transformers + PEFT
+  - Hardware: RunPod GPU instance
+  Evaluation
+  The model demonstrates strong performance in:
+  - Croatian language comprehension and generation
+  - Educational content creation
+  - Study material generation
+  - Academic question answering
+  Bias, Risks, and Limitations
+  - Primary focus on Croatian educational content
+  - May reflect biases present in training data
+  - Best suited for educational contexts
+  - Performance may vary on non-educational tasks
+  Citation
+  @model{studypal-llm-1.0,
+    title={StudyPal-LLM-1.0: A Croatian Educational Assistant},
+    author={aerodynamics21},
+    year={2024},
+    url={https://huggingface.co/aerodynamics21/StudyPal-LLM-1.0}
+  }
+  Model Card Authors
+  aerodynamics21
+  Model Card Contact
+  For questions about this model, please visit the repository or create an issue.