Upload folder using huggingface_hub

README.md

@@ -1,123 +1,175 @@
----
-library_name: transformers
-license: apache-2.0
-base_model: Qwen/Qwen2.5-Coder-3B-Instruct
-pipeline_tag: text-generation
-tags:
-- code
-- code-analysis
-- qwen
-- qwen2
-- text-generation
-- transformers
-- fine-tuned
----
-
-# Code Analyzer Model
-
-Fine-tuned версия модели Qwen2.5-Coder-3B-Instruct для анализа кода и ответов на вопросы о программировании.
-
-## Описание модели
-
-Эта модель предназначена для оцекнивания кода и выявления слабых и сильных мест в решении связанные с программированием. Модель основана на Qwen2.5-Coder-3B-Instruct и дообучена с использованием LoRA (Low-Rank Adaptation).
-
-## Быстрый старт
-
-Вы можете использовать эту модель прямо в интерфейсе Hugging Face с помощью кнопки "Use this model" или загрузить локально.
-
-## Использование
-
-### С помощью transformers
-
-```python
-from transformers import AutoModelForCausalLM, AutoTokenizer
-import torch
-
-model_name = "Vilyam888/Code_analyze.1.0"
-
-tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
-model = AutoModelForCausalLM.from_pretrained(
-    model_name,
-    torch_dtype=torch.bfloat16,
-    device_map="auto",
-    trust_remote_code=True
-)
-
-# Формат запроса
-prompt = "Проанализируй этот код:\ndef hello():\n    print('Hello, World!')"
-
-# Форматирование в стиле обучения
-text = f"{prompt}\n\nОтвет:\n"
-
-inputs = tokenizer(text, return_tensors="pt").to(model.device)
-
-with torch.no_grad():
-    outputs = model.generate(
-        **inputs,
-        max_new_tokens=512,
-        temperature=0.7,
-        top_p=0.8,
-        top_k=20,
-        repetition_penalty=1.05,
-        do_sample=True
-    )
-
-response = tokenizer.decode(outputs[0], skip_special_tokens=True)
-print(response)
-```
-
-### С помощью pipeline
-
-```python
-from transformers import pipeline
-
-model_name = "Vilyam888/Code_analyze.1.0"
-
-generator = pipeline(
-    "text-generation",
-    model=model_name,
-    tokenizer=model_name,
-    trust_remote_code=True,
-    device_map="auto"
-)
-
-prompt = "Объясни, что делает этот код:\ndef factorial(n):\n    if n <= 1:\n        return 1\n    return n * factorial(n-1)"
-text = f"{prompt}\n\nОтвет:\n"
-
-result = generator(
-    text,
-    max_new_tokens=512,
-    temperature=0.7,
-    top_p=0.8,
-    top_k=20,
-    repetition_penalty=1.05,
-    do_sample=True
-)
-
-print(result[0]["generated_text"])
-```
-
-## Детали обучения
-
-- **Базовая модель:** Qwen/Qwen2.5-Coder-3B-Instruct
-- **Метод обучения:** LoRA (Low-Rank Adaptation)
-- **Параметры LoRA:**
-  - `r`: 16
-  - `lora_alpha`: 32
-  - `lora_dropout`: 0.05
-- **Фреймворк:** TRL (Transformer Reinforcement Learning)
-- **Формат данных:** JSONL с полями `input` и `output`
-
-## Ограничения
-
-- Модель обучена на русском языке для анализа кода
-- Может генерировать неточные или неполные ответы
-- Требует GPU для эффективной работы
-
-## Лицензия
-
-Apache 2.0
-
-## Авторы
-
-Fine-tuned by Vilyam888
+---
+library_name: transformers
+license: apache-2.0
+base_model: Qwen/Qwen2.5-Coder-3B-Instruct
+pipeline_tag: text-generation
+inference: true
+tags:
+- code
+- code-analysis
+- qwen
+- qwen2
+- text-generation
+- transformers
+- fine-tuned
+widget:
+- text: "Проанализируй этот код:\ndef hello():\n    print('Hello, World!')"
+  example_title: "Анализ простого кода"
+- text: "Объясни, что делает эта функция:\ndef factorial(n):\n    if n <= 1:\n        return 1\n    return n * factorial(n-1)"
+  example_title: "Объяснение функции"
+---
+
+# Code Analyzer Model
+
+Fine-tuned версия модели Qwen2.5-Coder-3B-Instruct для анализа кода и ответов на вопросы о программировании.
+
+## Описание модели
+
+Эта модель была обучена на датасете ITOG для анализа кода и предоставления ответов на вопросы, связанные с программированием. Модель основана на Qwen2.5-Coder-3B-Instruct и дообучена с использованием LoRA (Low-Rank Adaptation).
+
+## Быстрый старт
+
+### Вариант 1: Использование виджета на странице модели
+
+1. Перейдите на страницу модели: https://huggingface.co/Vilyam888/Code_analyze.1.0
+2. Прокрутите страницу вниз до раздела **"Hosted inference API"** или **"Widget"**
+3. Введите ваш запрос в текстовое поле виджета
+4. Нажмите "Compute" для получения ответа
+
+**Примечание:** Если опция "Inference" не отображается в меню "Use this model", используйте виджет на странице модели или один из вариантов ниже.
+
+### Вариант 2: Использование локально (Python)
+
+**Установка зависимостей:**
+```bash
+pip install transformers torch
+```
+
+**Простой пример использования:**
+```python
+from transformers import pipeline
+
+# Создаем pipeline для генерации текста
+generator = pipeline(
+    "text-generation",
+    model="Vilyam888/Code_analyze.1.0",
+    trust_remote_code=True
+)
+
+# Задаем вопрос
+prompt = "Проанализируй этот код:\ndef hello():\n    print('Hello, World!')"
+text = f"{prompt}\n\nОтвет:\n"
+
+# Генерируем ответ
+result = generator(text, max_new_tokens=512, temperature=0.7)
+print(result[0]["generated_text"])
+```
+
+**Или используйте готовые скрипты из репозитория:**
+
+Простой пример (минимальный код):
+```bash
+python scripts/quick_start_example.py
+```
+
+Полный пример с интерактивным режимом:
+```bash
+python scripts/use_model_example.py
+```
+
+## Использование
+
+### С помощью transformers
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import torch
+
+model_name = "Vilyam888/Code_analyze.1.0"
+
+tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(
+    model_name,
+    torch_dtype=torch.bfloat16,
+    device_map="auto",
+    trust_remote_code=True
+)
+
+# Формат запроса
+prompt = "Проанализируй этот код:\ndef hello():\n    print('Hello, World!')"
+
+# Форматирование в стиле обучения
+text = f"{prompt}\n\nОтвет:\n"
+
+inputs = tokenizer(text, return_tensors="pt").to(model.device)
+
+with torch.no_grad():
+    outputs = model.generate(
+        **inputs,
+        max_new_tokens=512,
+        temperature=0.7,
+        top_p=0.8,
+        top_k=20,
+        repetition_penalty=1.05,
+        do_sample=True
+    )
+
+response = tokenizer.decode(outputs[0], skip_special_tokens=True)
+print(response)
+```
+
+### С помощью pipeline
+
+```python
+from transformers import pipeline
+
+model_name = "Vilyam888/Code_analyze.1.0"
+
+generator = pipeline(
+    "text-generation",
+    model=model_name,
+    tokenizer=model_name,
+    trust_remote_code=True,
+    device_map="auto"
+)
+
+prompt = "Объясни, что делает этот код:\ndef factorial(n):\n    if n <= 1:\n        return 1\n    return n * factorial(n-1)"
+text = f"{prompt}\n\nОтвет:\n"
+
+result = generator(
+    text,
+    max_new_tokens=512,
+    temperature=0.7,
+    top_p=0.8,
+    top_k=20,
+    repetition_penalty=1.05,
+    do_sample=True
+)
+
+print(result[0]["generated_text"])
+```
+
+## Детали обучения
+
+- **Базовая модель:** Qwen/Qwen2.5-Coder-3B-Instruct
+- **Метод обучения:** LoRA (Low-Rank Adaptation)
+- **Параметры LoRA:**
+  - `r`: 16
+  - `lora_alpha`: 32
+  - `lora_dropout`: 0.05
+- **Фреймворк:** TRL (Transformer Reinforcement Learning)
+- **Формат данных:** JSONL с полями `input` и `output`
+
+## Ограничения
+
+- Модель обучена на русском языке для анализа кода
+- Может генерировать неточные или неполные ответы
+- Требует GPU для эффективной работы
+
+## Лицензия
+
+Apache 2.0
+
+## Авторы
+
+Fine-tuned by Vilyam888