Build, modify, and control your own personalized LLMs

xTuring provides fast, efficient and simple fine-tuning of open-source LLMs, such as Mistral, LLaMA, GPT-J, and more. By providing an easy-to-use interface for fine-tuning LLMs to your own data and application, xTuring makes it simple to build, modify, and control LLMs. The entire process can be done inside your computer or in your private cloud, ensuring data privacy and security.

With xTuring you can,

• Ingest data from different sources and preprocess them to a format LLMs can understand
• Scale from single to multiple GPUs for faster fine-tuning
• Leverage memory-efficient methods (i.e. INT4, LoRA fine-tuning) to reduce hardware costs by up to 90%
• Explore different fine-tuning methods and benchmark them to find the best performing model
• Evaluate fine-tuned models on well-defined metrics for in-depth analysis

⚙️ Installation

pip install xturing

🚀 Quickstart

from xturing.datasets import InstructionDataset
from xturing.models import BaseModel

# Load the dataset
instruction_dataset = InstructionDataset("./examples/models/llama/alpaca_data")

# Initialize the model
model = BaseModel.create("llama_lora")

# Finetune the model
model.finetune(dataset=instruction_dataset)

# Perform inference
output = model.generate(texts=["Why LLM models are becoming so important?"])

print("Generated output by the model: {}".format(output))

You can find the data folder here.

🌟 What's new?

We are excited to announce the latest enhancements to our xTuring library:

1. LLaMA 2 integration - You can use and fine-tune the LLaMA 2 model in different configurations: off-the-shelf, off-the-shelf with INT8 precision, LoRA fine-tuning, LoRA fine-tuning with INT8 precision and LoRA fine-tuning with INT4 precision using the GenericModel wrapper and/or you can use the Llama2 class from xturing.models to test and finetune the model.

   
   from xturing.models import Llama2
   model = Llama2()

or

from xturing.models import BaseModel model = BaseModel.create('llama2')

2. __`Evaluation`__ - Now you can evaluate any `Causal Language Model` on any dataset. The metrics currently supported is [`perplexity`](https://en.wikipedia.org/wiki/Perplexity).
```python
# Make the necessary imports
from xturing.datasets import InstructionDataset
from xturing.models import BaseModel

# Load the desired dataset
dataset = InstructionDataset('../llama/alpaca_data')

# Load the desired model
model = BaseModel.create('gpt2')

# Run the Evaluation of the model on the dataset
result = model.evaluate(dataset)

# Print the result
print(f"Perplexity of the evalution: {result}")

3. INT4 Precision - You can now use and fine-tune any LLM with INT4 Precision using GenericLoraKbitModel.

   
   # Make the necessary imports
   from xturing.datasets import InstructionDataset
   from xturing.models import GenericLoraKbitModel

Load the desired dataset

dataset = InstructionDataset('../llama/alpaca_data')

Load the desired model for INT4 bit fine-tuning

model = GenericLoraKbitModel('tiiuae/falcon-7b')

Run the fine-tuning

model.finetune(dataset)

4. __CPU inference__ - The CPU, including laptop CPUs, is now fully equipped to handle LLM inference. We integrated [Intel® Extension for Transformers](https://github.com/intel/intel-extension-for-transformers) to conserve memory by compressing the model with [weight-only quantization algorithms](https://github.com/intel/intel-extension-for-transformers/blob/main/docs/weightonlyquant.md) and accelerate the inference by leveraging its highly optimized kernel on Intel platforms.

```python
# Make the necessary imports
from xturing.models import BaseModel

# Initializes the model: quantize the model with weight-only algorithms
# and replace the linear with Itrex's qbits_linear kernel
model = BaseModel.create("llama2_int8")

# Once the model has been quantized, do inferences directly
output = model.generate(texts=["Why LLM models are becoming so important?"])
print(output)

5. Batch integration - By tweaking the 'batch_size' in the .generate() and .evaluate() functions, you can expedite results. Using a 'batch_size' greater than 1 typically enhances processing efficiency.

   
   # Make the necessary imports
   from xturing.datasets import InstructionDataset
   from xturing.models import GenericLoraKbitModel

Load the desired dataset

dataset = InstructionDataset('../llama/alpaca_data')

Load the desired model for INT4 bit fine-tuning

model = GenericLoraKbitModel('tiiuae/falcon-7b')

Generate outputs on desired prompts

outputs = model.generate(dataset = dataset, batch_size=10)

An exploration of the [Llama LoRA INT4 working example](examples/features/int4_finetuning/LLaMA_lora_int4.ipynb) is recommended for an understanding of its application.

For an extended insight, consider examining the [GenericModel working example](examples/features/generic/generic_model.py) available in the repository.

<br>

## CLI playground
<img src="https://github.com/stochasticai/xTuring/raw/main/github/cli-playground.gif" width="80%" style="margin: 0 1%;"/>

```bash
$ xturing chat -m "<path-to-model-folder>"

UI playground

from xturing.datasets import InstructionDataset
from xturing.models import BaseModel
from xturing.ui import Playground

dataset = InstructionDataset("./alpaca_data")
model = BaseModel.create("<model_name>")

model.finetune(dataset=dataset)

model.save("llama_lora_finetuned")

Playground().launch() ## launches localhost UI

📚 Tutorials

• Preparing your dataset
• Cerebras-GPT fine-tuning with LoRA and INT8  
• Cerebras-GPT fine-tuning with LoRA  
• LLaMA fine-tuning with LoRA and INT8  
• LLaMA fine-tuning with LoRA
• LLaMA fine-tuning
• GPT-J fine-tuning with LoRA and INT8  
• GPT-J fine-tuning with LoRA
• GPT-2 fine-tuning with LoRA  

📊 Performance

Here is a comparison for the performance of different fine-tuning techniques on the LLaMA 7B model. We use the Alpaca dataset for fine-tuning. The dataset contains 52K instructions.

Hardware:

4xA100 40GB GPU, 335GB CPU RAM

Fine-tuning parameters:

{
  'maximum sequence length': 512,
  'batch size': 1,
}

Contribute to this by submitting your performance results on other GPUs by creating an issue with your hardware specifications, memory consumption and time per epoch.

📎 Fine-tuned model checkpoints

We have already fine-tuned some models that you can use as your base or start playing with. Here is how you would load them:

from xturing.models import BaseModel
model = BaseModel.load("x/distilgpt2_lora_finetuned_alpaca")

Supported Models

Below is a list of all the supported models via BaseModel class of xTuring and their corresponding keys to load them.

The above mentioned are the base variants of the LLMs. Below are the templates to get their LoRA, INT8, INT8 + LoRA and INT4 + LoRA versions.

** In order to load any model's INT4+LoRA version, you will need to make use of GenericLoraKbitModel class from xturing.models. Below is how to use it:

model = GenericLoraKbitModel('<model_path>')

The model_path can be replaced with you local directory or any HuggingFace library model like facebook/opt-1.3b.

📈 Roadmap

• [x] Support for LLaMA, GPT-J, GPT-2, OPT, Cerebras-GPT, Galactica and Bloom models
• [x] Dataset generation using self-instruction
• [x] Low-precision LoRA fine-tuning and unsupervised fine-tuning
• [x] INT8 low-precision fine-tuning support
• [x] OpenAI, Cohere and AI21 Studio model APIs for dataset generation
• [x] Added fine-tuned checkpoints for some models to the hub
• [x] INT4 LLaMA LoRA fine-tuning demo
• [x] INT4 LLaMA LoRA fine-tuning with INT4 generation
• [x] Support for a Generic model wrapper
• [x] Support for Falcon-7B model
• [x] INT4 low-precision fine-tuning support
• [x] Evaluation of LLM models
• [ ] INT3, INT2, INT1 low-precision fine-tuning support
• [ ] Support for Stable Diffusion

🤝 Help and Support

If you have any questions, you can create an issue on this repository.

You can also join our Discord server and start a discussion in the #xturing channel.

📝 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🌎 Contributing

As an open source project in a rapidly evolving field, we welcome contributions of all kinds, including new features and better documentation. Please read our contributing guide to learn how you can get involved.