Skip to content

Latest commit

 

History

History
executable file
·
301 lines (251 loc) · 12.4 KB

README.md

File metadata and controls

executable file
·
301 lines (251 loc) · 12.4 KB
Raw

🚀 Turbo-Alignment

Library for industrial alignment.

Table of Contents

🌟 What is Turbo-Alignment?

Turbo-Alignment is a library designed to streamline the fine-tuning and alignment of large language models, leveraging advanced techniques to enhance efficiency and scalability.

✨ Key Features

  • 📊 Comprehensive Metrics and Logging: Includes a wide range of metrics such as self-bleu, KL divergence, diversity, etc. all supported out of the box.
  • 🛠️ Streamlined Method Deployment: Simplifies the process of deploying new methods, allowing for quick development and integration of new datasets and trainers into your pipelines.
  • 📚 Ready-to-Use Examples: Convenient examples with configurations and instructions for basic tasks.
  • ⚡ Fast Inference: Optimized for quick inference using vLLM.
  • 🔄 End-to-End Pipelines: From data preprocessing to model alignment.
  • 🌐 Multimodal Capabilities: Extensive support for various multimodal functions like Vision Language Modeling.
  • 🔍 RAG Pipeline: Unique pipeline for end2end retrieval-augmented generation training.

🛠️ Supported Methods

Turbo-Alignment supports a wide range of methods for model training and alignment, including:

  • 🎯 Supervised Fine-Tuning (SFT)
  • 🏆 Reward Modeling (RM)
  • 👍 Direct Preference Optimization (DPO)
  • 🧠 Kahneman & Tversky Optimization (KTO) Paired/Unpaired
  • 🔄 Contrastive Preference Optimization (CPO)
  • 🎭 Identity Preference Optimisation (IPO)
  • 🌟 Sequence Likelihood Calibration with Human Feedback (SLiC-HF)
  • 📊 Statistical Rejection Sampling Optimization (RSO)
  • 🌁 Vision Language Modeling using MLP from (LLaVA) or C-Abstractor from (HoneyBee) trainable projection model
  • 🗂️ Retrieval-Augmented Generation (RAG)

🧮 Implemented Metrics

  • 🔠 Distinctness
  • 🌈 Diversity
  • 🔵 Self-BLEU
  • ➗ KL-divergence
  • 🏆 Reward
  • 📏 Length
  • 🌀 Perplexity
  • 🌟 METEOR
  • 🔍 Retrieval Utility

🤖 How to Use

Turbo-Alignment offers an intuitive interface for training and aligning large language models. Refer to the detailed examples and configuration files in the documentation to get started quickly with your specific use case. User-friendly guid available here.

The most crucial aspect is to prepare the dataset in the required format, after which the pipeline will handle everything automatically. Examples of datasets are available here.

Table of use-cases

Train

Supervised Fine-Tuning

  • 📚 Dataset type prepare your dataset in the ChatDataset, examples available here format.
  • 📝 Configs Example: sft.json
  • 🖥️ CLI launch command
python -m turbo_alignment train_sft --experiment_settings_path tutorials/sft/sft.json

Preference Tuning

Reward Modeling

  • 📚 Dataset type prepare your dataset in the PairPreferencesDataset format, examples available here
  • 📝 Configs Example: rm.json
  • 🖥️ CLI launch command
python -m turbo_alignment train_rm --experiment_settings_path tutorials/rm/rm.json

DPO, IPO, CPO, KTO (Paired)

  • 📚 Dataset type prepare your dataset in the PairPreferencesDataset format, examples available here
  • 📝 Configs Example: dpo.json
  • 🖥️ CLI launch command
python -m turbo_alignment train_dpo --experiment_settings_path tutorials/dpo/dpo.json

KTO (Unpaired)

  • 📚 Dataset type prepare your dataset in the KTODataset format, examples available here
  • 📝 Configs Examples: kto.json
  • 🖥️ CLI launch command
python -m turbo_alignment train_kto --experiment_settings_path tutorials/kto/kto.json

Multimodal train

⌛️ in progress..

RAG (Retrieval-Augmented Generation)

SFT-RAG

  • 📚 Dataset type: prepare your dataset in ChatDataset, examples available here format.
  • 📝 Configs Example: sft_retrieval_utility.json
  • 🖥️ CLI launch command:
python -m turbo_alignment train_sft --experiment_settings_path tests/fixtures/configs/train/sft/sft_retrieval_utility.json

End2End-RAG

  • 📚 Dataset type: prepare your dataset in ChatDataset, examples available here format.
  • 📝 Configs Example: end2end.json
  • 🖥️ CLI launch command:
python -m turbo_alignment train_rag --experiment_settings_path tests/fixtures/configs/train/rag/end2end.json

Inference

Chat Inference

  • 📚 Dataset type prepare your dataset in the ChatDataset, examples available here format.
  • 📝 Configs Example: base.json
  • 🖥️ CLI launch command
python -m turbo_alignment inference_chat --inference_settings_path tests/fixtures/configs/inference/sft/base.json

Classification Inference

  • 📚 Dataset type prepare your dataset in the ClassificationDataset, examples available here format.
  • 📝 Configs Example: classification_inference.json
  • 🖥️ CLI launch command
python -m turbo_alignment inference_classification --inference_settings_path tests/fixtures/configs/inference/classification/base.json

Multimodal Inference

  • 📚 Dataset type prepare your dataset in the MultimodalDataset, examples available here format.
  • 📝 Configs Example: llama_llava_clip_pickle.json
  • 🖥️ CLI launch command
python -m turbo_alignment inference_multimodal --inference_settings_path tests/fixtures/configs/inference/multimodal/llama_llava_clip_pickle.json

RAG Inference

  • 📚 Dataset type prepare your dataset in the ChatDataset, examples available here format.
  • 📝 Configs Example: rag_inference.json
  • 🖥️ CLI launch command
python -m turbo_alignment inference_rag --inference_settings_path tests/fixtures/configs/inference/rag/base.json

Sampling

Random Sampling

  • 📚 Dataset type prepare your dataset in the SamplingRMDataset, examples available here format.
  • 📝 Configs Example: random.json
  • 🖥️ CLI launch command
python -m turbo_alignment random_sample --experiment_settings_path tests/fixtures/configs/sampling/base.json

RSO Sampling

  • 📚 Dataset type prepare your dataset in the SamplingRMDataset, examples available here format.
  • 📝 Configs Example: rso.json
  • 🖥️ CLI launch command
python -m turbo_alignment rso_sample --experiment_settings_path tests/fixtures/configs/sampling/rso.json

Reward Model Sampling

  • 📚 Dataset type prepare your dataset in the SamplingRMDataset, examples available here format.
  • 📝 Configs Example: rm.json
  • 🖥️ CLI launch command
python -m turbo_alignment rm_sample --experiment_settings_path tests/fixtures/configs/sampling/rm.json

Common

Merge Adapters to base model

  • 📝 Configs Example: merge.json
  • 🖥️ CLI launch command
python -m turbo_alignment merge_adapters_to_base --settings_path tests/fixtures/configs/utils/merge_adapters_to_base/merge.json

Preprocess Multimodal Dataset

python -m turbo_alignment preprocess_multimodal_dataset --settings_path tutorials/utils/preprocess/coco2014_clip.json

🚀 Installation

📦 Python Package

pip install turbo-alignment

🛠️ From Source

For the latest features before an official release:

pip install git+https://github.com/turbo-llm/turbo-alignment.git

📂 Repository

Clone the repository for access to examples:

git clone https://github.com/turbo-llm/turbo-alignment.git

🌱 Development

Contributions are welcome! Read the contribution guide and set up the development environment:

git clone https://github.com/turbo-llm/turbo-alignment.git
cd turbo-alignment
poetry install

📍 Library Roadmap

  • Increasing number of tutorials
  • Enhancing test coverage
  • Implementation of Online RL methods like PPO and Reinforce
  • Facilitating distributed training
  • Incorporating low-memory training approaches

❓ FAQ

How do I install Turbo-Alignment?

See the Installation section for detailed instructions.

Where can I find docs?

Guides and docs are available here.

Where can I find tutorials?

Tutorials are available here.

📝 License

This project is licensed, see the LICENSE file for details.

References

  • DPO Trainer implementation inspired by Leandro von Werra et al. (2020) TRL: Transformer Reinforcement Learning. GitHub repository, GitHub. Available at: https://github.com/huggingface/trl.

  • Registry implementation inspired by Matt Gardner, Joel Grus, Mark Neumann, Oyvind Tafjord, Pradeep Dasigi, Nelson F. Liu, Matthew Peters, Michael Schmitz, and Luke S. Zettlemoyer. 2017. AllenNLP: A Deep Semantic Natural Language Processing Platform. Available at: arXiv:1803.07640.

  • Liger Kernels implementation inspired by Pin-Lun Hsu and Yun Dai and Vignesh Kothapalli and Qingquan Song and Shao Tang and Siyu Zhu and Steven Shimizu and Shivam Sahni and Haowen Ning and Yanning Chen, 2024. Liger-Kernel: Efficient Triton Kernels for LLM Training. Available at: https://github.com/linkedin/Liger-Kernel.