Skip to main content

SFT-DPO-QLora Trainer Package

Project description

SFT-DPO-QLora Trainer Package

Overview

Welcome to the SFT-DPO-QLora Trainer package! This package is designed to streamline the training process for large language models (LLMs) using the SFT (Scaling-Free Training) and QLora techniques, specifically tailored for Dialogue Preference Optimization (DPO) scenarios. This trainer handles the entire pipeline, from dataset processing to model fine-tuning, providing users with a convenient solution for their custom use cases.

Installation

To install the SFT-DPO-QLora Trainer package, follow these steps:

pip install sft-dpo-qlora

Usage

1. Import the Trainer and Config classes

from sft_dpo_qlora import sftTrainer,sftConfig

2. Create a Config object

config = sftConfig(
    MODEL_ID="Model/quantized-model",
    DATA=["YourHuggingFaceDataset/dataset-name","Questions","Answers]
    BITS=4,
    LORA_R=8,
    LORA_ALPHA=8,
    LORA_DROPOUT=0.1,
    TARGET_MODULES=["q_proj", "v_proj"],
    BIAS="none",
    TASK_TYPE="CAUSAL_LM",
    BATCH_SIZE=8,
    OPTIMIZER="paged_adamw_32bit",
    LR=2e-4,
    NUM_TRAIN_EPOCHS=1,
    MAX_STEPS=250,
    FP16=True,
    DATASET_SPLIT="test_prefs",
    MAX_LENGTH=512,
    MAX_TARGET_LENGTH=256,
    MAX_PROMPT_LENGTH=256,
    INFERENCE_MODE=False,
    LOGGING_FIRST_STEP=True,
    LOGGING_STEPS=10,
    OUTPUT_DIR="FineTune1",
    PUSH_TO_HUB=False
)

3. Initialize the Trainer with the Config object

trainer = sftTrainer(config)

4. Train the model

trainer.train()

Configuring the Trainer

The Config class allows you to customize various parameters for the training process. Key parameters include:

  • MODEL_ID: The identifier of the base model to use.
  • DATA: The Hugging Face dataset name , Instruction , Target
  • BITS: Number of bits for quantization.
  • LORA_R, LORA_ALPHA, LORA_DROPOUT: LoRA Adapter configuration.
  • TARGET_MODULES: Target modules for the LoRA Adapter.
  • BIAS: Bias for LoRA Adapter.
  • TASK_TYPE: Type of the task (e.g., "CAUSAL_LM").
  • BATCH_SIZE: Training batch size.
  • OPTIMIZER: Optimizer for training.
  • LR: Learning rate.
  • NUM_TRAIN_EPOCHS: Number of training epochs.
  • MAX_STEPS: Maximum number of training steps.
  • FP16: Enable mixed-precision training.
  • DATASET_SPLIT: Split of the dataset to use.
  • MAX_LENGTH, MAX_TARGET_LENGTH, MAX_PROMPT_LENGTH: Maximum sequence lengths.
  • INFERENCE_MODE: Enable inference mode for LoRA Adapter.
  • LOGGING_FIRST_STEP, LOGGING_STEPS: Logging configuration.
  • OUTPUT_DIR: Output directory for training results.
  • PUSH_TO_HUB: Push results to the Hugging Face Hub.

Adjust these parameters based on your specific requirements and the characteristics of your dialogue preference optimization task.

Dataset Processing

The Trainer class provides methods to download and process the training dataset:

  • _dpo_data: Downloads and processes the DPO dataset.

Model Preparation

The train method initiates the training loop using the specified dataset and model:

  • Downloads and processes the DPO dataset.
  • Prepares the model.
  • Sets training arguments.
  • Initializes the DPOTrainer from the trl library.
  • Trains the model.

Conclusion

With the SFT-DPO-QLora Trainer package, you can easily fine-tune large language models for dialogue preference optimization in your custom use case. Experiment with different configurations, datasets, and models to achieve optimal results. If you encounter any issues or have questions, please refer to the documentation or reach out to our support community. Happy training!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sft_dpo_qlora-0.1.4.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sft_dpo_qlora-0.1.4-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file sft_dpo_qlora-0.1.4.tar.gz.

File metadata

  • Download URL: sft_dpo_qlora-0.1.4.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for sft_dpo_qlora-0.1.4.tar.gz
Algorithm Hash digest
SHA256 5f6fa427b8bebf2a3f8478d20e1c05e7a976c152ca9d23d41f65b45d4ed4c13b
MD5 76eae99c5f23f5589170197568110bd3
BLAKE2b-256 46a33391a5c480a2a0ec5190d9cbe38b186992d803d2a42c3ff3bb0baf1b0454

See more details on using hashes here.

File details

Details for the file sft_dpo_qlora-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: sft_dpo_qlora-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for sft_dpo_qlora-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b1943d0c7266f38bf8524dd8eb0d151c3fdf65ce567b3f7031c6e87328fcd6b1
MD5 4cb6d60e54314e5073193812657f336a
BLAKE2b-256 a6a42bae5087f0c135a24fcca92cd579f727defd5e61497fe8bc17c8ff9fa135

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page