Instructions to use LL-Square/CodeForge-TinyLlama1.1B-Instruct with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use LL-Square/CodeForge-TinyLlama1.1B-Instruct with PEFT:

from peft import PeftModel
from transformers import AutoModelForCausalLM

base_model = AutoModelForCausalLM.from_pretrained("TinyLlama/TinyLlama-1.1B-Chat-v1.0")
model = PeftModel.from_pretrained(base_model, "LL-Square/CodeForge-TinyLlama1.1B-Instruct")

Transformers

How to use LL-Square/CodeForge-TinyLlama1.1B-Instruct with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="LL-Square/CodeForge-TinyLlama1.1B-Instruct")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("LL-Square/CodeForge-TinyLlama1.1B-Instruct", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use LL-Square/CodeForge-TinyLlama1.1B-Instruct with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "LL-Square/CodeForge-TinyLlama1.1B-Instruct"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "LL-Square/CodeForge-TinyLlama1.1B-Instruct",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/LL-Square/CodeForge-TinyLlama1.1B-Instruct

SGLang

How to use LL-Square/CodeForge-TinyLlama1.1B-Instruct with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "LL-Square/CodeForge-TinyLlama1.1B-Instruct" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "LL-Square/CodeForge-TinyLlama1.1B-Instruct",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "LL-Square/CodeForge-TinyLlama1.1B-Instruct" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "LL-Square/CodeForge-TinyLlama1.1B-Instruct",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Docker Model Runner
How to use LL-Square/CodeForge-TinyLlama1.1B-Instruct with Docker Model Runner:
```
docker model run hf.co/LL-Square/CodeForge-TinyLlama1.1B-Instruct
```

lazarusrolando commited on Jun 16

Commit

2199f7e

verified ·

1 Parent(s): 6e249ac

Update README.md

Browse files

Files changed (1) hide show

README.md +57 -165

README.md CHANGED Viewed

@@ -13,199 +13,91 @@ language:
 - en
 ---
-# 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]
-- **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.18.1

 - en
 ---
+# CodeForge-Instruct
+Lightweight repository for preparing, training, and uploading small instruct-style models and LoRA adapters.
+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`.
+## Quick overview
+- **Files:**
+	- `logging_setup.py` — central logging configuration used by scripts.
+	- `train.py` — training / fine-tuning entrypoint.
+	- `main.py` — minimal inference/demo runner.
+	- `upload.py` — helper to upload model artifacts to a hub or storage.
+	- `sample.jsonl` — small example dataset (one JSON object per line).
+	- `CodeForge-Instruct/` — supporting code and assets.
+## Requirements
+- Python 3.10+
+- Typical ML dependencies: `torch`, `transformers`, `peft`, `datasets`, `accelerate`, `tqdm`, `safetensors` (if used). Install example:
+```bash
+python -m venv .venv
+source .venv/Scripts/activate   # Windows: .venv\Scripts\activate
+pip install --upgrade pip
+pip install torch transformers peft datasets accelerate tqdm safetensors
+```
+If you prefer pinned dependencies, create `requirements.txt` and install via `pip install -r requirements.txt`.
+## Data format
+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`):
+```jsonl
+{"prompt": "Summarize the following text:", "response": "A short summary."}
+```
+Adjust `train.py` to match your field names if needed.
+## Usage
+Training (example):
+```bash
+python train.py --data sample.jsonl --output-dir ./checkpoints --epochs 3 --batch-size 8
+```
+Run inference/demo:
+```bash
+python main.py --model ./checkpoints/latest
+```
+Upload artifacts (example):
+```bash
+python upload.py --model ./checkpoints/latest --dest hub-or-bucket
+```
+See individual scripts for additional flags and configuration.
+## Logging
+The repository centralizes logging in `logging_setup.py`; import and call `setup_logging()` from other scripts to get consistent formatting and levels.
+## Development
+- Run linters/formatters as you prefer (e.g. `black`, `ruff`).
+- Add tests under a `tests/` folder if you expand behavior.
+## Contributing
+Open issues or PRs with clear reproduction steps. Keep changes minimal and scoped.
+## License
+This repository does not include a license file. Add a `LICENSE` if you plan to publish.
 ### Framework versions
+- PEFT 0.18.1
+-
+---
+If you'd like, I can:
+- add a `requirements.txt` with pinned versions,
+- add CLI argument parsing examples to `train.py` and `main.py`, or
+- create a short CONTRIBUTING guide.