companies-house-tinyllama

Model Card for Model ID

Fine-tuning a TinyLlama Model for Companies House Data Extraction

Model Details

TinyLlama 1.1B Chat v1.0

Model Description

This project fine-tunes the TinyLlama 1.1B Chat v1.0 model to perform structured data extraction from UK Companies House records. The goal is to train the model to recognize and complete specific patterns within the company record text, making it capable of generating structured outputs like JSON or completing partial records.

Key Libraries and Techniques Used:

• Hugging Face Transformers & Datasets: Provides the core framework for loading models, tokenizers, and datasets.
• Unsloth: A library that significantly accelerates fine-tuning and inference for popular LLMs, especially on resource-constrained environments like Colab. It achieves this through optimized kernels and efficient memory management, particularly for QLoRA.
• TRL (Transformer Reinforcement Learning): Specifically, the SFTTrainer was used for Supervised Fine-Tuning. This trainer simplifies the process of training models on instruction-following or structured text generation tasks.
• QLoRA: A parameter-efficient fine-tuning technique used via Unsloth. It reduces the memory footprint and computational cost of fine-tuning by introducing a small number of trainable parameters (LoRA adapters) while keeping the majority of the pre-trained model frozen in a quantized format.

Fine-tuning Process:

1. Data Preparation: The Companies House data (in JSON Lines format with a 'text' field) is loaded and processed. A custom formatting function is applied to structure the data for training. Depending on the training objective, this involves:

   • Causal Language Modeling (CLM): Training the model to predict the very next token in a sequence. For structured data, this means training on the entire record, including a defined end-of-record delimiter (e.g., "NEW_COMPANY_RECORD_END"). The model learns the patterns and sequences of the data corpus.
   • Instruction Following (using ChatML or Alpaca templates): Training the model to generate a specific "response" (like a JSON object or the latter part of a record) based on an "instruction" and "input" (the earlier part of the record). This teaches the model a task-specific behavior.

2. Model Loading & LoRA Adaptation: The base TinyLlama model is loaded in a 4-bit quantized format using Unsloth. LoRA adapters are then applied to specific layers of the model (q_proj, k_proj, v_proj, o_proj, gate_proj, up_proj, down_proj) to enable efficient fine-tuning.

3. Training Execution: The SFTTrainer is configured with hyperparameters (learning rate, batch size, epochs, etc.) and the prepared dataset. The trainer manages the training loop, updating the LoRA adapter weights based on the training objective. Techniques like gradient accumulation and gradient checkpointing (optimized by Unsloth) are used to handle larger batch sizes and sequence lengths within limited GPU memory.

4. Model Merging: After training, the trained LoRA adapter weights are merged back into the base model. This creates a single, standalone model file that can be easily loaded and used for inference without needing the original base model separately. Unsloth's save_pretrained_merged method handles this merging process efficiently, often supporting different output formats (e.g., 16-bit).

5. Evaluation: The fine-tuned model is evaluated using metrics like Perplexity (for CLM tasks) or by performing sample inferences to qualitatively assess its ability to generate the desired structured output and adhere to the learned format and delimiters.

6. Deployment Preparation (Optional): The merged model can be converted to other formats like GGUF using tools like llama.cpp or Unsloth's export functions, enabling deployment on various hardware and platforms, including consumer-grade CPUs/GPUs via libraries like llama.cpp or tools like Ollama.

This process leverages state-of-the-art techniques and libraries to efficiently adapt a pre-trained language model to a specific domain and task, resulting in a smaller, more specialized model capable of structured data extraction. This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.

• Developed by: [More Information Needed]
• Funded by [optional]: [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 presented in Lacoste et al. (2019).

• 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]