Text Generation
PEFT
Safetensors
Transformers
English
lora
conversational
lazarusrolando commited on
Commit
08a755e
·
verified ·
1 Parent(s): 2199f7e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -24
README.md CHANGED
@@ -19,30 +19,6 @@ Lightweight repository for preparing, training, and uploading small instruct-sty
19
 
20
  This project contains simple scripts to train a model (`train.py`), run inference (`main.py`), configure logging (`logging_setup.py`), and upload artifacts (`upload.py`). A small sample dataset is included as `sample.jsonl`.
21
 
22
- ## Quick overview
23
-
24
- - **Files:**
25
- - `logging_setup.py` — central logging configuration used by scripts.
26
- - `train.py` — training / fine-tuning entrypoint.
27
- - `main.py` — minimal inference/demo runner.
28
- - `upload.py` — helper to upload model artifacts to a hub or storage.
29
- - `sample.jsonl` — small example dataset (one JSON object per line).
30
- - `CodeForge-Instruct/` — supporting code and assets.
31
-
32
- ## Requirements
33
-
34
- - Python 3.10+
35
- - Typical ML dependencies: `torch`, `transformers`, `peft`, `datasets`, `accelerate`, `tqdm`, `safetensors` (if used). Install example:
36
-
37
- ```bash
38
- python -m venv .venv
39
- source .venv/Scripts/activate # Windows: .venv\Scripts\activate
40
- pip install --upgrade pip
41
- pip install torch transformers peft datasets accelerate tqdm safetensors
42
- ```
43
-
44
- If you prefer pinned dependencies, create `requirements.txt` and install via `pip install -r requirements.txt`.
45
-
46
  ## Data format
47
 
48
  The dataset expects newline-delimited JSON (`.jsonl`) where each line is an object with at least `prompt` and `response` (or `instruction`/`output`) fields. Example (`sample.jsonl`):
 
19
 
20
  This project contains simple scripts to train a model (`train.py`), run inference (`main.py`), configure logging (`logging_setup.py`), and upload artifacts (`upload.py`). A small sample dataset is included as `sample.jsonl`.
21
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
22
  ## Data format
23
 
24
  The dataset expects newline-delimited JSON (`.jsonl`) where each line is an object with at least `prompt` and `response` (or `instruction`/`output`) fields. Example (`sample.jsonl`):