gguf endpoints_compatible region:us conversational
---
{}
---
Quantization made by Richard Erkhov.

[Github](https://github.com/RichardErkhov)

[Discord](https://discord.gg/pvy7H8DZMG)

[Request more models](https://github.com/RichardErkhov/quant_request)


ChatFrame-Instruct-Persian-Small - GGUF
- Model creator: https://huggingface.co/frameai/
- Original model: https://huggingface.co/frameai/ChatFrame-Instruct-Persian-Small/


| Name | Quant method | Size |
| ---- | ---- | ---- |
| [ChatFrame-Instruct-Persian-Small.Q2_K.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q2_K.gguf) | Q2_K | 2.96GB |
| [ChatFrame-Instruct-Persian-Small.IQ3_XS.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.IQ3_XS.gguf) | IQ3_XS | 3.28GB |
| [ChatFrame-Instruct-Persian-Small.IQ3_S.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.IQ3_S.gguf) | IQ3_S | 3.43GB |
| [ChatFrame-Instruct-Persian-Small.Q3_K_S.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q3_K_S.gguf) | Q3_K_S | 3.41GB |
| [ChatFrame-Instruct-Persian-Small.IQ3_M.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.IQ3_M.gguf) | IQ3_M | 3.52GB |
| [ChatFrame-Instruct-Persian-Small.Q3_K.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q3_K.gguf) | Q3_K | 3.74GB |
| [ChatFrame-Instruct-Persian-Small.Q3_K_M.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q3_K_M.gguf) | Q3_K_M | 3.74GB |
| [ChatFrame-Instruct-Persian-Small.Q3_K_L.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q3_K_L.gguf) | Q3_K_L | 4.03GB |
| [ChatFrame-Instruct-Persian-Small.IQ4_XS.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.IQ4_XS.gguf) | IQ4_XS | 4.18GB |
| [ChatFrame-Instruct-Persian-Small.Q4_0.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q4_0.gguf) | Q4_0 | 4.34GB |
| [ChatFrame-Instruct-Persian-Small.IQ4_NL.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.IQ4_NL.gguf) | IQ4_NL | 4.38GB |
| [ChatFrame-Instruct-Persian-Small.Q4_K_S.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q4_K_S.gguf) | Q4_K_S | 4.37GB |
| [ChatFrame-Instruct-Persian-Small.Q4_K.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q4_K.gguf) | Q4_K | 4.58GB |
| [ChatFrame-Instruct-Persian-Small.Q4_K_M.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q4_K_M.gguf) | Q4_K_M | 4.58GB |
| [ChatFrame-Instruct-Persian-Small.Q4_1.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q4_1.gguf) | Q4_1 | 4.78GB |
| [ChatFrame-Instruct-Persian-Small.Q5_0.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q5_0.gguf) | Q5_0 | 5.21GB |
| [ChatFrame-Instruct-Persian-Small.Q5_K_S.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q5_K_S.gguf) | Q5_K_S | 5.21GB |
| [ChatFrame-Instruct-Persian-Small.Q5_K.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q5_K.gguf) | Q5_K | 5.34GB |
| [ChatFrame-Instruct-Persian-Small.Q5_K_M.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q5_K_M.gguf) | Q5_K_M | 5.34GB |
| [ChatFrame-Instruct-Persian-Small.Q5_1.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q5_1.gguf) | Q5_1 | 5.65GB |
| [ChatFrame-Instruct-Persian-Small.Q6_K.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q6_K.gguf) | Q6_K | 6.14GB |
| [ChatFrame-Instruct-Persian-Small.Q8_0.gguf](https://huggingface.co/RichardErkhov/frameai_-_ChatFrame-Instruct-Persian-Small-gguf/blob/main/ChatFrame-Instruct-Persian-Small.Q8_0.gguf) | Q8_0 | 7.95GB |




Original model description:
---
license: mit
language:
- en
- fa
library_name: transformers
pipeline_tag: text-generation
---
# ChatFrame-Persian Model Card

## Model Description
ChatFrame-Persian is an instruction-following AI model developed by AIFRAME INC. It is a large language model (LLM) designed for English and Persian language support. This model can be used for a variety of commercial applications and fine-tuning. ChatFrame-Persian demonstrates superior performance when compared to similar models such as Llama-70B, GPT-3.5, and GPT-4.

![photo_2024-08-20_01-12-06.jpg](https://cdn-uploads.huggingface.co/production/uploads/653c2bc15e4f2c3e884b6743/Qlzit7RLpqvTgodZPLXNS.jpeg)

## Intended Uses & Limitations
ChatFrame-Persian is intended for a wide range of language-based tasks, including but not limited to:
- Text generation and language translation
- Question answering and conversational AI
- Language understanding and analysis

The model has been trained on a diverse dataset, but it is important to note that its performance may vary across different cultural, demographic, and phenotypic groups.

## Model Architecture
ChatFrame-Persian utilizes a transformer-based architecture with a large number of parameters, allowing it to capture complex linguistic patterns and generate human-like responses.

## Training Data and Methodology
The model was trained on a vast dataset containing text data from various sources, including books, websites, and social media. The training process involved advanced techniques such as large-batch training and fine-tuning to optimize performance.

## Performance Metrics
ChatFrame-Persian excels in several key performance metrics, including accuracy, precision, and recall. It has been benchmarked against other leading models and consistently demonstrates superior results, especially in language generation and understanding tasks.

## Potential Biases and Limitations
While ChatFrame-Persian has been trained to minimize biases, it is important to recognize that all language models have limitations. Users should be aware of potential biases related to the training data and the possibility of generating inappropriate or offensive responses. Additionally, the model may struggle with highly specialized or technical language.

## Responsible AI Considerations
ChatFrame-Persian has been developed with a focus on responsible AI practices. The model has been trained to respect user privacy and adhere to ethical guidelines. It is important for users to monitor the model's output and provide feedback to continuously improve its performance and address any potential issues.

## Using pipeline to run model(A100 GPU tested):
```python
from transformers import pipeline
import torch

device = 0 if torch.cuda.is_available() else -1

def generate_response(user_input):
    pipe = pipeline("text-generation", model="frameai/ChatFrame-Instruct-Persian-Small", device = device)
    messages = [
        {"role": "user", "content": user_input},
    ]
    response = pipe(messages, max_length=512)
    return response[0]['generated_text'][1]["content"]

ai = generate_response(user_input = "ایران رو برام توصیف کن")
print(ai)
```

## Authors
Trained by Experts: The brainchild of Mohammadmoein Pisoude (CEO) and Alex Romniof (Manager), ChatFrame-Persian is the result of the dedication and expertise of the entire AIFRAME INC team. Their combined efforts in coding and project management have led to the creation of this innovative model.

