ncls-p
/

Qwen2.5-3B-blog-key-points

@@ -1,204 +1,118 @@
 ---
-library_name: transformers
 tags:
-- unsloth
 datasets:
 - ncls-p/blog-key-points
-base_model:
-- unsloth/Qwen2.5-3B-Instruct
 ---
-# 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]

 ---
+language:
+- en
 tags:
+- qwen2
+- text-generation
+- summarization
+- key-points
+- blog-summarization
 datasets:
 - ncls-p/blog-key-points
+license: cc-by-4.0
+base_model: Qwen/Qwen2.5-3B-Instruct
 ---
+# Qwen2.5-3B-blog-key-points
+This model is fine-tuned from [Qwen/Qwen2.5-3B-Instruct](https://huggingface.co/Qwen/Qwen2.5-3B-Instruct) on the [blog-key-points dataset](https://huggingface.co/datasets/ncls-p/blog-key-points). It specializes in extracting key points from blog articles and web content, providing concise bullet-point summaries that capture the essential information.
+## Model Description
+**Qwen2.5-3B-blog-key-points** is a 3B parameter model fine-tuned specifically for the task of extracting key points from articles. It can process a full article and generate a concise, bullet-point summary highlighting the most important information.
+### Model Details
+- **Model Type:** Qwen2.5 (3B parameters)
+- **Base Model:** [Qwen/Qwen2.5-3B-Instruct](https://huggingface.co/Qwen/Qwen2.5-3B-Instruct)
+- **Training Dataset:** [ncls-p/blog-key-points](https://huggingface.co/datasets/ncls-p/blog-key-points)
+- **Language:** English
+- **License:** [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/)
+- **Finetuning Approach:** Instruction fine-tuning on article-summary pairs
 ## Uses
 ### Direct Use
+This model is designed for extracting key points from articles. You can use it directly for:
+- Summarizing blog posts
+- Extracting important information from news articles
+- Creating bullet-point summaries of long-form content
+- Generating concise overviews of research papers
+### Example Usage
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+model_id = "ncls-p/Qwen2.5-3B-blog-key-points"
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(model_id)
+article = """
+[Your article text here]
+"""
+prompt = f"""
+Extract the key points from the following article:
+{article}
+"""
+inputs = tokenizer(prompt, return_tensors="pt")
+outputs = model.generate(**inputs, max_length=1024)
+response = tokenizer.decode(outputs[0], skip_special_tokens=True)
+print(response)
+```
+## Training
+The model was fine-tuned on the [blog-key-points dataset](https://huggingface.co/datasets/ncls-p/blog-key-points), which contains 200 article-summary pairs. Each pair consists of a full article and a bullet-point summary of key points extracted using Perplexity AI.
 ### Training Procedure
+- **Fine-tuning Framework:** [Unsloth](https://github.com/unslothai/unsloth)
+- **Training Data Format:**
+  ```json
+  {
+    "instruction": "",
+    "input": "Full article content",
+    "output": "Here are the key points of the article:\n* Key point 1\n* Key point 2\n* Key point 3\n..."
+  }
+  ```
 ## Evaluation
+The model was evaluated on its ability to extract relevant key points from articles not seen during training. Evaluation metrics focused on:
+1. **Relevance:** How well the extracted points capture the main ideas of the article
+2. **Conciseness:** The ability to summarize information in a clear, bullet-point format
+3. **Completeness:** Whether all important information is captured in the summary
+## Limitations and Biases
+- The model may inherit biases present in the training data, including potential biases in the source articles or in the key point extraction process.
+- Performance may vary depending on the length, complexity, and domain of the input article.
+- The model is primarily trained on English-language content and may not perform well on content in other languages.
+- As with any summarization model, there is a risk of omitting important information or misrepresenting the original content.
+## How to Cite
+If you use this model in your research, please cite:
+```bibtex
+@misc{qwen25-3b-blog-key-points,
+  author = {ncls-p},
+  title = {Qwen2.5-3B-blog-key-points},
+  year = {2024},
+  publisher = {Hugging Face},
+  journal = {Hugging Face model repository},
+  howpublished = {\url{https://huggingface.co/ncls-p/Qwen2.5-3B-blog-key-points}},
+}
+```
+## Dataset Creation
+The dataset used to train this model was created using the [Dataset Enhancer with Perplexity AI](https://github.com/ncls-p/pplx-to-dataset), a CLI tool that extracts key points from web articles using Perplexity AI's API and adds them to a dataset in a structured format.