PersianLLaMA-13B / README.md
aminabbasi's picture
Update README.md
be1bb03 verified
metadata
license: cc-by-nc-4.0
language:
  - fa
library_name: transformers
tags:
  - text-generation-inference
inference: false
pipeline_tag: text-generation

PersianLLaMA: Towards Building First Persian Large Language Model

PersianLLaMA

🌟 Introduction

Welcome to the home of PersianLLaMA, the pioneering large language model for the Persian language. With 13 billion parameters, this model is trained on Persian Wikipedia corpus and designed to excel in multiple NLP tasks, setting a new benchmark for Persian language understanding and generation.

πŸ›  Model Description

PersianLLaMA is not just a model but a comprehensive tool for:

  • πŸ“ Text Generation: Crafting coherent and contextually appropriate text.
  • 🎯 Instruct Tuning: Executing tasks based on detailed instructions, ideal for scenarios where the model needs to adhere to specific guidelines or produce outputs tailored to particular requirements.
  • ❓ Question Answering: Providing accurate answers to Persian queries.
  • πŸ“Š Text Summarization: Condensing Persian texts into precise summaries.

This model has been collaboratively developed by a team of experts, including Mohammad Amin Abbasi, Arash Ghafouri, Mahdi Firouzmandi, Hassan Naderi, Behrouz Minaei Bidgoli.

πŸš€ Quick Start

To integrate PersianLLaMA into your project, follow these steps:

from transformers import AutoModelForCausalLM, AutoTokenizer

model_name = "ViraIntelligentDataMining/PersianLLaMA-13B"
tokenizer = AutoTokenizer.from_pretrained(model_name)
model = AutoModelForCausalLM.from_pretrained(model_name)

prompt = "Ψ§ΫŒΩ† Ω…ΨͺΩ† Ψ¨Ω‡ فارسی Ψ§Ψ³Ψͺ"
inputs = tokenizer(prompt, return_tensors="pt")
outputs = model.generate(inputs["input_ids"])
print(tokenizer.decode(outputs[0], skip_special_tokens=True))

πŸ“ˆ Evaluation and Benchmarks

PersianLLaMA demonstrates superior performance over existing models, with robust evaluation metrics that highlight its capabilities in natural language understanding and generation.

πŸ“œ Citing PersianLLaMA

If you find PersianLLaMA useful in your research, please consider citing:

@article{abbasi2023persianllama,
  title={PersianLLaMA: Towards Building First Persian Large Language Model},
  author={Abbasi, Mohammad Amin and others},
  journal={https://arxiv.org/abs/2312.15713},
  year={2023}
}

πŸ“„ License

PersianLLaMA is open-sourced under the CC BY-NC 4.0 license.