diff --git a/fine_tuning_code_llm_on_single_gpu.ipynb b/notebooks/en/fine_tuning_code_llm_on_single_gpu.ipynb similarity index 65% rename from fine_tuning_code_llm_on_single_gpu.ipynb rename to notebooks/en/fine_tuning_code_llm_on_single_gpu.ipynb index 68685b39..153522df 100644 --- a/fine_tuning_code_llm_on_single_gpu.ipynb +++ b/notebooks/en/fine_tuning_code_llm_on_single_gpu.ipynb @@ -1,52 +1,70 @@ { + "nbformat": 4, + "nbformat_minor": 0, + "metadata": { + "colab": { + "provenance": [], + "machine_shape": "hm", + "gpuType": "A100" + }, + "kernelspec": { + "name": "python3", + "display_name": "Python 3" + }, + "language_info": { + "name": "python" + }, + "accelerator": "GPU" + }, "cells": [ { "cell_type": "markdown", - "metadata": { - "id": "FNdZ-kD0l78P" - }, "source": [ - "# تنظیم دقیق مدل زبانی بزرگ مبتنی بر کد با کد‌های شخصی توسط یک هسته GPU\n", + "# Fine-tuning a Code LLM on Custom Code on a single GPU\n", "\n", - "_نویسنده: [Maria Khalusova](https://github.com/MKhalusova)_\n", + "_Authored by: [Maria Khalusova](https://github.com/MKhalusova)_\n", "\n", - "مدل‌های زبانی بزرگ‌ (LLM) عمومیِ مبتنی بر کد از جمله Codex, StarCoder و CodeLlama در تولید کدهایی که از اصول کلی برنامه ‌نویسی و سینتکس پیروی می کنند عالی هستند، اما ممکن است با قراردادهای داخلی سازمان مطابقت نداشته باشند یا از کتابخانه های اختصاصی مطلع نباشند.\n", + "Publicly available code LLMs such as Codex, StarCoder, and Code Llama are great at generating code that adheres to general programming principles and syntax, but they may not align with an organization's internal conventions, or be aware of proprietary libraries.\n", "\n", - "در این دفترچه، نحوه تنظیم دقیق (fine-tune) یک LLM مبتنی بر کد بر روی کد‌های خصوصی ‌را برای بهبود آگاهی زمینه‌ای آن و افزایش مفید بودن مدل برای نیازهای سازمان شما نشان خواهیم داد. از آنجایی که LLM های مبتنی بر کد بسیار بزرگ هستند، تنظیم دقیق آنها به روش سنتی می‌تواند از نظر منابع پر‌مصرف باشد. نگران نباشید! ما نحوه بهینه سازی تنظیم دقیق را برای جایگذاری روی یک هسته GPU نشان خواهیم داد.\n", + "In this notebook, we'll see show how you can fine-tune a code LLM on private code bases to enhance its contextual awareness and improve a model's usefulness to your organization's needs. Since the code LLMs are quite large, fine-tuning them in a traditional manner can be resource-draining. Worry not! We will show how you can optimize fine-tuning to fit on a single GPU.\n", "\n", - "## دیتاست\n", "\n", - "برای این مثال، ما ۱۰ ریپازیتوری عمومی برتر Hugging Face را از Github انتخاب کردیم. ما فایل‌های غیر کد مانند تصاویر، فایل‌های صوتی، ارائه‌ها و غیره را از داده‌ها حذف کرده‌ایم. برای Jupyter Notebook ها، ما فقط سلول‌هایی را که حاوی کد هستند نگه داشته‌ایم. کد حاصل به عنوان دیتاستی ذخیره می‌شود که آن را در Hugging Face Hub تحت [`smangrul/hf-stack-v1`](https://huggingface.co/datasets/smangrul/hf-stack-v1) پیدا کنید. این دیتاست شامل شناسه ریپازیتوری، مسیر فایل و محتوای فایل است. \n", + "## Dataset\n", "\n", + "For this example, we picked the top 10 Hugging Face public repositories on GitHub. We have excluded non-code files from the data, such as images, audio files, presentations, and so on. For Jupyter notebooks, we've kept only cells containing code. The resulting code is stored as a dataset that you can find on the Hugging Face Hub under [`smangrul/hf-stack-v1`](https://huggingface.co/datasets/smangrul/hf-stack-v1). It contains repo id, file path, and file content.\n", "\n", - "## مدل\n", "\n", - "ما مدل [`bigcode/starcoderbase-1b`](https://huggingface.co/bigcode/starcoderbase-1b) که یک مدل با یک میلیارد پارامتر است و روی بیش از ۸۰ زبان برنامه نویسی آموزش دیده است را تنظیم دقیق می‌کنیم. دسترسی به این مدل محدود است، بنابرین اگر قصد دارید این دفترچه را با همین مدل اجرا کنید، باید از صفحه مدل به آن دسترسی پیدا کنید. برای انجام این کار، با حساب کاربری Hugging Face خود وارد شوید." - ] + "## Model\n", + "\n", + "We'll finetune [`bigcode/starcoderbase-1b`](https://huggingface.co/bigcode/starcoderbase-1b), which is a 1B parameter model trained on 80+ programming languages. This is a gated model, so if you plan to run this notebook with this exact model, you'll need to gain access to it on the model's page. Log in to your Hugging Face account to do so:" + ], + "metadata": { + "id": "FNdZ-kD0l78P" + } }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "bPlCJYDK6vrF" - }, - "outputs": [], "source": [ "from huggingface_hub import notebook_login\n", "\n", "notebook_login()" - ] + ], + "metadata": { + "id": "bPlCJYDK6vrF" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", - "metadata": { - "id": "WMVe_c8q43Qo" - }, "source": [ - "برای شروع، بیایید تمام کتابخانه‌های ضروری را نصب کنیم. همانطور که می‌بینید، علاوه بر `transformers` و `datasets`، از `peft`، `bitsandbytes` و `flash-attn` برای بهینه‌سازی آموزش مدل استفاده خواهیم کرد.\n", + "To get started, let's install all the necessary libraries. As you can see, in addition to `transformers` and `datasets`, we'll be using `peft`, `bitsandbytes`, and `flash-attn` to optimize the training.\n", "\n", - "با استفاده از تکنیک‌های آموزش کارآمد پارامتر، می‌توانیم این دفترچه را روی یک GPU A100 با رم بالا اجرا کنیم." - ] + "By employing parameter-efficient training techniques, we can run this notebook on a single A100 High-RAM GPU." + ], + "metadata": { + "id": "WMVe_c8q43Qo" + } }, { "cell_type": "code", @@ -61,20 +79,15 @@ }, { "cell_type": "markdown", + "source": [ + "Let's define some variables now. Feel free to play with these." + ], "metadata": { "id": "16EdABzt3_Ig" - }, - "source": [ - "اکنون چند متغیر تعریف می‌کنیم. در بازی کردن با مقدار این متغیر‌ها راحت باشید." - ] + } }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "hru3G-CLmqis" - }, - "outputs": [], "source": [ "MODEL=\"bigcode/starcoderbase-1b\" # Model checkpoint on the Hugging Face Hub\n", "DATASET=\"smangrul/hf-stack-v1\" # Dataset on the Hugging Face Hub\n", @@ -112,15 +125,15 @@ "BNB_4BIT_COMPUTE_DTYPE=\"bfloat16\"# bnb_4bit_compute_dtype\n", "\n", "SEED=0" - ] + ], + "metadata": { + "id": "hru3G-CLmqis" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "FyZSXTbJrcnC" - }, - "outputs": [], "source": [ "from transformers import (\n", " AutoModelForCausalLM,\n", @@ -133,35 +146,35 @@ ")\n", "\n", "set_seed(SEED)" - ] + ], + "metadata": { + "id": "FyZSXTbJrcnC" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", + "source": [ + "## Prepare the data" + ], "metadata": { "id": "pO7F5L5AtKo1" - }, - "source": [ - "## آماده‌سازی داده‌ها" - ] + } }, { "cell_type": "markdown", - "metadata": { - "id": "1LmrIZqP0oUE" - }, "source": [ - "با بارگذاری داده شروع کنید. از آنجایی که به احتمال زیاد دیتاست بسیار بزرگ است، حتما حالت استریم (streaming) را فعال کنید. استریم به ما این امکان را می‌دهد که داده‌ها را به تدریج در حالی که روی دیتاست تکرار می‌کنیم، بارگذاری کنیم به جای اینکه کل دیتاست را به طور همزمان دانلود کنیم.\n", + "Begin by loading the data. As the dataset is likely to be quite large, make sure to enable the streaming mode. Streaming allows us to load the data progressively as we iterate over the dataset instead of downloading the whole dataset at once.\n", "\n", - "ما ۴۰۰۰ نمونه اول را به عنوان دیتاست اعتبارسنجی (validation set) اختصاص خواهیم داد و باقی‌مانده به عنوان داده‌های آموزشی در نظر گرفته می‌شود." - ] + "We'll reserve the first 4000 examples as the validation set, and everything else will be the training data." + ], + "metadata": { + "id": "1LmrIZqP0oUE" + } }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "4oJZvZb-1J88" - }, - "outputs": [], "source": [ "from datasets import load_dataset\n", "import torch\n", @@ -178,24 +191,45 @@ "valid_data = dataset.take(4000)\n", "train_data = dataset.skip(4000)\n", "train_data = train_data.shuffle(buffer_size=5000, seed=SEED)" - ] + ], + "metadata": { + "id": "4oJZvZb-1J88" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", - "metadata": { - "id": "sLQ8t0LM2GR6" - }, "source": [ - "**تبدیلات اختیاری FIM (مدل پرکردن میانی)**\n", - "\n", - "مدل‌های زبان خودبازگشت (Autoregressive) معمولا توالی‌ها را از چپ به راست تولید می‌کنند. با اعمال تبدیلات FIM، مدل همچنین می‌تواند یاد بگیرد که متن را در بخش‌های میانی پر کند. برای اطلاعات بیشتر در مورد این تکنیک، به مقاله‌ی [Efficient Training of Language Models to Fill in the Middle](https://arxiv.org/pdf/2207.14255.pdf) مراجعه کنید.\n", + "At this step, the dataset still contains raw data with code of arbitraty length. For training, we need inputs of fixed length. Let's create an Iterable dataset that would return constant-length chunks of tokens from a stream of text files.\n", "\n", - "ما در اینجا تبدیلات FIM را تعریف می‌کنیم و هنگام ایجاد دیتاست قابل تکرار (Iterable Dataset) از آن‌ها استفاده خواهیم کرد. با این حال، اگر می‌خواهید تبدیلی صورت نگیرد، می‌توانید پارامتر fim_rate را روی ۰ تنظیم کنید." - ] + "First, let's estimate the average number of characters per token in the dataset, which will help us later estimate the number of tokens in the text buffer later. By default, we'll only take 400 examples (`nb_examples`) from the dataset. Using only a subset of the entire dataset will reduce computational cost while still providing a reasonable estimate of the overall character-to-token ratio." + ], + "metadata": { + "id": "sLQ8t0LM2GR6" + } }, { "cell_type": "code", - "execution_count": null, + "source": [ + "tokenizer = AutoTokenizer.from_pretrained(MODEL, trust_remote_code=True)\n", + "\n", + "def chars_token_ratio(dataset, tokenizer, data_column, nb_examples=400):\n", + " \"\"\"\n", + " Estimate the average number of characters per token in the dataset.\n", + " \"\"\"\n", + "\n", + " total_characters, total_tokens = 0, 0\n", + " for _, example in tqdm(zip(range(nb_examples), iter(dataset)), total=nb_examples):\n", + " total_characters += len(example[data_column])\n", + " total_tokens += len(tokenizer(example[data_column]).tokens())\n", + "\n", + " return total_characters / total_tokens\n", + "\n", + "\n", + "chars_per_token = chars_token_ratio(train_data, tokenizer, DATA_COLUMN)\n", + "print(f\"The character to token ratio of the dataset is: {chars_per_token:.2f}\")" + ], "metadata": { "colab": { "base_uri": "https://localhost:8080/" @@ -203,79 +237,55 @@ "id": "KCiAvydztNsu", "outputId": "cabf7fd0-a922-4371-cbc6-60ee99ef7469" }, + "execution_count": null, "outputs": [ { - "name": "stderr", "output_type": "stream", + "name": "stderr", "text": [ "100%|██████████| 400/400 [00:10<00:00, 39.87it/s] " ] }, { - "name": "stdout", "output_type": "stream", + "name": "stdout", "text": [ "The character to token ratio of the dataset is: 2.43\n" ] }, { - "name": "stderr", "output_type": "stream", + "name": "stderr", "text": [ "\n" ] } - ], - "source": [ - "tokenizer = AutoTokenizer.from_pretrained(MODEL, trust_remote_code=True)\n", - "\n", - "def chars_token_ratio(dataset, tokenizer, data_column, nb_examples=400):\n", - " \"\"\"\n", - " Estimate the average number of characters per token in the dataset.\n", - " \"\"\"\n", - "\n", - " total_characters, total_tokens = 0, 0\n", - " for _, example in tqdm(zip(range(nb_examples), iter(dataset)), total=nb_examples):\n", - " total_characters += len(example[data_column])\n", - " total_tokens += len(tokenizer(example[data_column]).tokens())\n", - "\n", - " return total_characters / total_tokens\n", - "\n", - "\n", - "chars_per_token = chars_token_ratio(train_data, tokenizer, DATA_COLUMN)\n", - "print(f\"The character to token ratio of the dataset is: {chars_per_token:.2f}\")" ] }, { "cell_type": "markdown", + "source": [ + "The character-to-token ratio can also be used as an indicator of the quality of text tokenization. For instance, a character-to-token ratio of 1.0 would mean that each character is represented with a token, which is not very meaningful. This would indicate poor tokenization. In standard English text, one token is typically equivalent to approximately four characters, meaning the character-to-token ratio is around 4.0. We can expect a lower ratio in the code dataset, but generally speaking, a number between 2.0 and 3.5 can be considered good enough." + ], "metadata": { "id": "6F13VGobB3Ma" - }, - "source": [ - "نسبت کاراکتر به توکن همچنین می‌تواند به عنوان شاخصی از کیفیت توکنیزه‌کردن متن استفاده شود. برای مثال، نسبت کاراکتر به توکن ۱٫۰ به این معنی است که هر کاراکتر با یک توکن نمایش داده می‌شود، که چندان معنی‌دار نیست. این نشان‌دهنده توکنیزه‌کردن ضعیف است. در متن استاندارد انگلیسی، یک توکن معمولاً معادل تقریباً چهار کاراکتر است، یعنی نسبت کاراکتر به توکن حدود ۴٫۰ است. در دیتاست کد انتظار داریم این نسبت کمتر باشد، اما به طور کلی، عددی بین ۲٫۰ تا ۳٫۵ را می توان به اندازه کافی خوب در نظر گرفت." - ] + } }, { "cell_type": "markdown", - "metadata": { - "id": "rcwYFRPpwxea" - }, "source": [ - "**تبدیلات اختیاری FIM (مدل پرکردن میانی)**\n", + "**Optional FIM transformations**\n", "\n", "\n", - "مدل‌های زبان خودبازگشت (Autoregressive) معمولا توالی‌ها را از چپ به راست تولید می‌کنند. با اعمال تبدیلات FIM، مدل همچنین می‌تواند یاد بگیرد که متن را در بخش‌های میانی پر کند. برای اطلاعات بیشتر در مورد این تکنیک، به مقاله‌ی \"آموزش کارآمد مدل‌های زبان برای پر کردن بخش میانی\" (Efficient Training of Language Models to Fill in the Middle): https://arxiv.org/pdf/2207.14255.pdf مراجعه کنید.\n", - "\n", - "ما در اینجا تبدیلات FIM را تعریف می‌کنیم و هنگام ایجاد دیتاست قابل تکرار (Iterable Dataset) از آن‌ها استفاده خواهیم کرد. با این حال، اگر می‌خواهید تبدیلی صورت نگیرد، می‌توانید پارامتر fim_rate را روی ۰ تنظیم کنید." - ] + "Autoregressive language models typically generate sequences from left to right. By applying the FIM transformations, the model can also learn to infill text. Check out [\"Efficient Training of Language Models to Fill in the Middle\" paper](https://arxiv.org/pdf/2207.14255.pdf) to learn more about the technique.\n", + "We'll define the FIM transformations here and will use them when creating the Iterable Dataset. However, if you want to omit transformations, feel free to set `fim_rate` to 0." + ], + "metadata": { + "id": "rcwYFRPpwxea" + } }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "zmejYvEKw1E-" - }, - "outputs": [], "source": [ "import functools\n", "import numpy as np\n", @@ -367,26 +377,26 @@ " new_sample = sample\n", "\n", " return list(new_sample), np_rng\n" - ] + ], + "metadata": { + "id": "zmejYvEKw1E-" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", - "metadata": { - "id": "AwW5FviD9xBH" - }, "source": [ - "بیایید ConstantLengthDataset را تعریف کنیم، یک دیتاست قابل تکرار که قطعاتی با طول ثابت از توکن‌ها را برمی‌گرداند. برای انجام این کار، بافر متنی را از مجموعه داده اصلی می‌خوانیم تا به محدودیت‌های اندازه برسیم و سپس از توکنایزر برای تبدیل متن خام به ورودی‌های توکن شده استفاده می‌کنیم. به صورت اختیاری، ما تبدیلات FIM را روی برخی از توالی‌ها انجام می‌دهیم (نسبت توالی‌های تحت تاثیر پارامتر fim_rate کنترل می‌شود).\n", + "Let's define the `ConstantLengthDataset`, an Iterable dataset that will return constant-length chunks of tokens. To do so, we'll read a buffer of text from the original dataset until we hit the size limits and then apply tokenizer to convert the raw text into tokenized inputs. Optionally, we'll perform FIM transformations on some sequences (the proportion of sequences affected is controlled by `fim_rate`).\n", "\n", - "پس از تعریف، می‌توانیم نمونه‌هایی از ConstantLengthDataset را هم از داده‌های آموزشی و هم از داده‌های اعتبارسنجی ایجاد کنیم." - ] + "Once defined, we can create instances of the `ConstantLengthDataset` from both training and validation data." + ], + "metadata": { + "id": "AwW5FviD9xBH" + } }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "AgDW-692wzOl" - }, - "outputs": [], "source": [ "from torch.utils.data import IterableDataset\n", "from torch.utils.data.dataloader import DataLoader\n", @@ -517,43 +527,43 @@ " fim_spm_rate=FIM_SPM_RATE,\n", " seed=SEED,\n", ")" - ] + ], + "metadata": { + "id": "AgDW-692wzOl" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", + "source": [ + "## Prepare the model" + ], "metadata": { "id": "rxev1sk6tRW9" - }, - "source": [ - "## آماده‌ سازی مدل" - ] + } }, { "cell_type": "markdown", - "metadata": { - "id": "UCtWV-U42Eq_" - }, "source": [ - "حالا که داده‌ها آماده شدند، زمان بارگذاری مدل است! ما قصد داریم نسخه کوانتیده شده‌ی مدل را بارگذاری کنیم.\n", + "Now that the data is prepared, it's time to load the model! We're going to load the quantized version of the model.\n", "\n", - "کوانتیز‌ه‌سازی باعث کاهش استفاده از حافظه می‌شود، زیرا داده‌ها را با بیت‌های کمتری نمایش می‌دهد. برای کوانتیزه کردن مدل از کتابخانه‌ی bitsandbytes استفاده خواهیم کرد، زیرا این کتابخانه با transformers یکپارچگی خوبی دارد. تنها کاری که باید انجام دهیم پیکربندی اولیه bitsandbytes است و سپس می‌توانیم هنگام بارگذاری مدل از آن استفاده کنیم.\n", + "This will allow us to reduce memory usage, as quantization represents data with fewer bits. We'll use the `bitsandbytes` library to quantize the model, as it has a nice integration with `transformers`. All we need to do is define a `bitsandbytes` config, and then use it when loading the model.\n", "\n", - "انواع مختلفی از کوانتیزه کردن ۴ بیتی وجود دارد، اما به طور کلی، ما برای عملکرد بهتر استفاده از کوانتیزه‌سازی NF4 را توصیه می‌کنیم (`bnb_4bit_quant_type=\"nf4\"`).\n", + "There are different variants of 4bit quantization, but generally, we recommend using NF4 quantization for better performance (`bnb_4bit_quant_type=\"nf4\"`).\n", "\n", - "گزینه‌ی `bnb_4bit_use_double_quant` یک کوانتیزه‌سازی دوم را پس از کوانتیزه‌سازی اول اضافه می‌کند تا ۰.۴ بیت اضافی به ازای هر پارامتر ذخیره شود.\n", + "The `bnb_4bit_use_double_quant` option adds a second quantization after the first one to save an additional 0.4 bits per parameter.\n", "\n", - "برای اطلاعات بیشتر در مورد کوانتیزه‌سازی، به پست وبلاگ [\"Making LLMs even more accessible with bitsandbytes, 4-bit quantization and QLoRA\"](https://huggingface.co/blog/4bit-transformers-bitsandbytes) مراجعه کنید.\n", + "To learn more about quantization, check out the [\"Making LLMs even more accessible with bitsandbytes, 4-bit quantization and QLoRA\" blog post](https://huggingface.co/blog/4bit-transformers-bitsandbytes).\n", "\n", - "پس از تعریف پیکربندی، آن را به متد from_pretrained ارسال کنید تا نسخه کوانتیده‌ شده‌ی مدل بارگذاری شود." - ] + "Once defined, pass the config to the `from_pretrained` method to load the quantized version of the model." + ], + "metadata": { + "id": "UCtWV-U42Eq_" + } }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "XuwoX6U2DUvK" - }, - "outputs": [], "source": [ "from peft import LoraConfig, get_peft_model, prepare_model_for_kbit_training\n", "from peft.tuners.lora import LoraLayer\n", @@ -581,44 +591,62 @@ " trust_remote_code=True,\n", " use_flash_attention_2=True,\n", ")\n" - ] + ], + "metadata": { + "id": "XuwoX6U2DUvK" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", + "source": [ + "When using a quantized model for training, you need to call the `prepare_model_for_kbit_training()` function to preprocess the quantized model for training." + ], "metadata": { "id": "bO9e2FV8D8ZF" - }, - "source": [ - "برای استفاده از یک مدل کوانتیزه شده جهت آموزش، لازم است تابع `prepare_model_for_kbit_training` را فراخوانی کنید تا مدل کوانتیزه شده را برای آموزش آماده‌سازی کند." - ] + } }, { "cell_type": "code", - "execution_count": null, + "source": [ + "model = prepare_model_for_kbit_training(model)" + ], "metadata": { "id": "Qb_eB4xzEDBk" }, - "outputs": [], - "source": [ - "model = prepare_model_for_kbit_training(model)" - ] + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", - "metadata": { - "id": "lmnLjPZpDVtg" - }, "source": [ - "حالا که مدل کمی سازی شده آماده است، می توانیم پیکربندی LoRA را تنظیم کنیم. LoRA با کاهش چشمگیر تعداد پارامترهای قابل آموزش، فرآیند تنظیم دقیق را کارآمدتر می کند.\n", + "Now that the quantized model is ready, we can set up a LoRA configuration. LoRA makes fine-tuning more efficient by drastically reducing the number of trainable parameters.\n", "\n", - "برای آموزش یک مدل با استفاده از تکنیک LoRA، باید مدل پایه را به عنوان یک `PeftModel` بپوشانیم. این شامل تعریف پیکربندی LoRA با `LoraConfig` و پوشاندن مدل اصلی با `get_peft_model()` با استفاده از `LoraConfig` است.\n", + "To train a model using LoRA technique, we need to wrap the base model as a `PeftModel`. This involves definign LoRA configuration with `LoraConfig`, and wrapping the original model with `get_peft_model()` using the `LoraConfig`.\n", "\n", - "برای کسب اطلاعات بیشتر در مورد LoRA و پارامترهای آن، به مستندات [PEFT documentation](https://huggingface.co/docs/peft/conceptual_guides/lora) مراجعه کنید." - ] + "To learn more about LoRA and its parameters, refer to [PEFT documentation](https://huggingface.co/docs/peft/conceptual_guides/lora)." + ], + "metadata": { + "id": "lmnLjPZpDVtg" + } }, { "cell_type": "code", - "execution_count": null, + "source": [ + "# Set up lora\n", + "peft_config = LoraConfig(\n", + " lora_alpha=LORA_ALPHA,\n", + " lora_dropout=LORA_DROPOUT,\n", + " r=LORA_R,\n", + " bias=\"none\",\n", + " task_type=\"CAUSAL_LM\",\n", + " target_modules=LORA_TARGET_MODULES.split(\",\"),\n", + ")\n", + "\n", + "model = get_peft_model(model, peft_config)\n", + "model.print_trainable_parameters()" + ], "metadata": { "colab": { "base_uri": "https://localhost:8080/" @@ -626,68 +654,50 @@ "id": "_pAUU2FR2Gey", "outputId": "63328c2b-e693-49b1-ce0a-3ca8722f852a" }, + "execution_count": null, "outputs": [ { - "name": "stdout", "output_type": "stream", + "name": "stdout", "text": [ "trainable params: 5,554,176 || all params: 1,142,761,472 || trainable%: 0.4860310866343243\n" ] } - ], - "source": [ - "# Set up lora\n", - "peft_config = LoraConfig(\n", - " lora_alpha=LORA_ALPHA,\n", - " lora_dropout=LORA_DROPOUT,\n", - " r=LORA_R,\n", - " bias=\"none\",\n", - " task_type=\"CAUSAL_LM\",\n", - " target_modules=LORA_TARGET_MODULES.split(\",\"),\n", - ")\n", - "\n", - "model = get_peft_model(model, peft_config)\n", - "model.print_trainable_parameters()" ] }, { "cell_type": "markdown", + "source": [ + "As you can see, by applying LoRA technique we will now need to train less than 1% of the parameters." + ], "metadata": { "id": "tHe7AElXzXVV" - }, - "source": [ - "همانطور که مشاهده می کنید، با به کارگیری تکنیک LoRA، اکنون نیاز به آموزش کمتر از ۱ درصد از پارامترها خواهیم داشت." - ] + } }, { "cell_type": "markdown", + "source": [ + "## Train the model" + ], "metadata": { "id": "T_CqVydc40IM" - }, - "source": [ - "## آموزش مدل" - ] + } }, { "cell_type": "markdown", - "metadata": { - "id": "Q_iN2khjrbD3" - }, "source": [ - "حالا که داده ها را آماده کرده ایم و مدل را بهینه کرده ایم، آماده ایم تا همه چیز کنار هم آورده و آموزش را شروع کنیم.\n", + "Now that we have prepared the data, and optimized the model, we are ready to bring everything together to start the training.\n", "\n", - "برای ایجاد یک `Trainer`، باید پیکربندی آموزش را تعریف کنید. مهمترین بخش `TrainingArguments` است، کلاسی که شامل تمام ویژگی های پیکربندی آموزش می شود.\n", + "To instantiate a `Trainer`, you need to define the training configuration. The most important is the `TrainingArguments`, which is a class that contains all the attributes to configure the training.\n", "\n", - "این موارد مشابه هر نوع آموزش مدل دیگری هستند که ممکن است اجرا کنید، بنابراین در اینجا به جزئیات نمی‌پردازیم." - ] + "These are similar to any other kind of model training you may run, so we won't go into detail here." + ], + "metadata": { + "id": "Q_iN2khjrbD3" + } }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "65QHS8l1tKQe" - }, - "outputs": [], "source": [ "train_data.start_iteration = 0\n", "\n", @@ -714,20 +724,32 @@ " push_to_hub=True,\n", " include_tokens_per_second=True,\n", ")\n" - ] + ], + "metadata": { + "id": "65QHS8l1tKQe" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", + "source": [ + "As a final step, instantiate the `Trainer` and call the `train` method. " + ], "metadata": { "id": "kB_fLRex09ut" - }, - "source": [ - "به عنوان آخرین مرحله، `Trainer` را ایجاد کرده و متد `train` را فراخوانی کنید." - ] + } }, { "cell_type": "code", - "execution_count": null, + "source": [ + "trainer = Trainer(\n", + " model=model, args=training_args, train_dataset=train_dataset, eval_dataset=eval_dataset\n", + ")\n", + "\n", + "print(\"Training...\")\n", + "trainer.train()\n" + ], "metadata": { "colab": { "base_uri": "https://localhost:8080/", @@ -736,8 +758,12 @@ "id": "rS3nVwhUC69O", "outputId": "61a5bdb2-b7d0-4aed-8290-4bf20c2ccd38" }, + "execution_count": null, "outputs": [ { + "metadata": { + "tags": null + }, "name": "stdout", "output_type": "stream", "text": [ @@ -745,7 +771,11 @@ ] }, { + "output_type": "display_data", "data": { + "text/plain": [ + "" + ], "text/html": [ "\n", "
\n", @@ -864,72 +894,55 @@ " \n", " \n", "

" - ], - "text/plain": [ - "" ] }, - "metadata": {}, - "output_type": "display_data" + "metadata": {} }, { + "output_type": "execute_result", "data": { "text/plain": [ "TrainOutput(global_step=2000, training_loss=4.885598585128784, metrics={'train_runtime': 15380.3075, 'train_samples_per_second': 2.081, 'train_steps_per_second': 0.13, 'train_tokens_per_second': 4261.033, 'total_flos': 4.0317260660736e+17, 'train_loss': 4.885598585128784, 'epoch': 1.0})" ] }, - "execution_count": 19, "metadata": {}, - "output_type": "execute_result" + "execution_count": 19 } - ], - "source": [ - "trainer = Trainer(\n", - " model=model, args=training_args, train_dataset=train_dataset, eval_dataset=eval_dataset\n", - ")\n", - "\n", - "print(\"Training...\")\n", - "trainer.train()\n" ] }, { "cell_type": "markdown", + "source": [ + "Finally, you can push the fine-tuned model to your Hub repository to share with your team." + ], "metadata": { "id": "aAERlCnt1PEW" - }, - "source": [ - "در نهایت، می‌توانید مدل تنظیم‌ دقیق شده را به ریپازیتوی هاب خود پوش کنید تا با تیم خود به اشتراک بگذارید." - ] + } }, { "cell_type": "code", - "execution_count": null, + "source": [ + "trainer.push_to_hub()" + ], "metadata": { "id": "1h7_AUTTDwE1" }, - "outputs": [], - "source": [ - "trainer.push_to_hub()" - ] + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", - "metadata": { - "id": "KBVH7uFOM_UF" - }, "source": [ - "## استنتاج (Inference)\n", + "## Inference\n", "\n", - "بعد از اینکه مدل بر روی هاب آپلود شد، می‌توانیم برای استنتاج از آن استفاده کنیم. برای انجام این کار، ابتدا مدل پایه اصلی و توکنایزر آن را مقداردهی اولیه می‌کنیم. سپس، نیاز داریم تا وزن‌های تنظیم‌ دقیق شده را با مدل پایه ادغام (merge) کنیم." - ] + "Once the model is uploaded to Hub, we can use it for inference. To do so we first initialize the original base model and its tokenizer. Next, we need to merge the fine-duned weights with the base model." + ], + "metadata": { + "id": "KBVH7uFOM_UF" + } }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "jtL37piINBFe" - }, - "outputs": [], "source": [ "from peft import PeftModel\n", "import torch\n", @@ -948,24 +961,24 @@ "peft_model_id = f\"Your_HF_username/{OUTPUT_DIR}\"\n", "model = PeftModel.from_pretrained(base_model, peft_model_id)\n", "model.merge_and_unload()" - ] + ], + "metadata": { + "id": "jtL37piINBFe" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", + "source": [ + "Now we can use the merged model for inference. For convenience, we'll define a `get_code_completion` - feel free to experiment with text generation parameters!" + ], "metadata": { "id": "3USQ2suvDi9M" - }, - "source": [ - "حالا می‌توانیم از مدل ادغام‌شده برای استنتاج استفاده کنیم. برای سهولت، ما یک تابع به نام `get_code_completion` تعریف می‌کنیم - در تغییر پارامترهای تولید متن راحت باشید!" - ] + } }, { "cell_type": "code", - "execution_count": null, - "metadata": { - "id": "RoTGpNbjDeWI" - }, - "outputs": [], "source": [ "def get_code_completion(prefix, suffix):\n", " text = prompt = f\"\"\"{prefix}{suffix}\"\"\"\n", @@ -980,20 +993,33 @@ " repetition_penalty=1.0,\n", " )\n", " return tokenizer.batch_decode(outputs, skip_special_tokens=True)[0]" - ] + ], + "metadata": { + "id": "RoTGpNbjDeWI" + }, + "execution_count": null, + "outputs": [] }, { "cell_type": "markdown", + "source": [ + "Now all we need to do to get code completion is call the `get_code_complete` function and pass the first few lines that we want to be completed as a prefix, and an empty string as a suffix." + ], "metadata": { "id": "0kMJiGDfDrBf" - }, - "source": [ - "حال برای دریافت ویژگی کد تکمیل‌ شونده، تنها کاری که باید انجام دهیم فراخوانی تابع `get_code_complete` است. ورودی‌های این تابع چند خط اولی که می‌خواهید تکمیل شوند به عنوان پیشوند و یک رشته خالی به عنوان پسوند هستند " - ] + } }, { "cell_type": "code", - "execution_count": null, + "source": [ + "prefix = \"\"\"from peft import LoraConfig, TaskType, get_peft_model\n", + "from transformers import AutoModelForCausalLM\n", + "peft_config = LoraConfig(\n", + "\"\"\"\n", + "suffix =\"\"\"\"\"\"\n", + "\n", + "print(get_code_completion(prefix, suffix))" + ], "metadata": { "colab": { "base_uri": "https://localhost:8080/" @@ -1001,10 +1027,11 @@ "id": "nXlco2_-YcvM", "outputId": "41c411ad-b7dc-4277-f975-c173888234bb" }, + "execution_count": null, "outputs": [ { - "name": "stdout", "output_type": "stream", + "name": "stdout", "text": [ "from peft import LoraConfig, TaskType, get_peft_model\n", "from transformers import AutoModelForCausalLM\n", @@ -1023,31 +1050,30 @@ "model.print_trainable_parameters()\n" ] } - ], - "source": [ - "prefix = \"\"\"from peft import LoraConfig, TaskType, get_peft_model\n", - "from transformers import AutoModelForCausalLM\n", - "peft_config = LoraConfig(\n", - "\"\"\"\n", - "suffix =\"\"\"\"\"\"\n", - "\n", - "print(get_code_completion(prefix, suffix))" ] }, { "cell_type": "markdown", - "metadata": { - "id": "Ql2563kGlnmu" - }, "source": [ - "همانطور که مشاهده کردید، به عنوان شخصی که در این دفترچه از کتابخانه PEFT استفاده کردید، نتیجه تولید شده برای ایجاد یک `LoraConfig` بسیار خوب است!\n", + "As someone who has just used the PEFT library earlier in this notebook, you can see that the generated result for creating a `LoraConfig` is rather good!\n", "\n", - "اگر به سلولی که مدل را برای استنتاج ایجاد کردیم برگردید و خطوطی را که وزن‌های تنظیم‌ دقیق شده را ادغام می‌کنند کامنت کنید، می‌توانید ببینید که مدل اصلی برای همان پیشوند دقیقاً چه چیزی تولید می‌کرد:" - ] + "If you go back to the cell where we instantiate the model for inference, and comment out the lines where we merge the fine-tuned weights, you can see what the original model would've generated for the exact same prefix:" + ], + "metadata": { + "id": "Ql2563kGlnmu" + } }, { "cell_type": "code", - "execution_count": null, + "source": [ + "prefix = \"\"\"from peft import LoraConfig, TaskType, get_peft_model\n", + "from transformers import AutoModelForCausalLM\n", + "peft_config = LoraConfig(\n", + "\"\"\"\n", + "suffix =\"\"\"\"\"\"\n", + "\n", + "print(get_code_completion(prefix, suffix))" + ], "metadata": { "colab": { "base_uri": "https://localhost:8080/" @@ -1055,10 +1081,11 @@ "id": "29xxp1eHTgJ9", "outputId": "c6d597a2-01da-4d25-a32f-3a551212c5b4" }, + "execution_count": null, "outputs": [ { - "name": "stdout", "output_type": "stream", + "name": "stdout", "text": [ "from peft import LoraConfig, TaskType, get_peft_model\n", "from transformers import AutoModelForCausalLM\n", @@ -1077,63 +1104,25 @@ " hidden\n" ] } - ], - "source": [ - "prefix = \"\"\"from peft import LoraConfig, TaskType, get_peft_model\n", - "from transformers import AutoModelForCausalLM\n", - "peft_config = LoraConfig(\n", - "\"\"\"\n", - "suffix =\"\"\"\"\"\"\n", - "\n", - "print(get_code_completion(prefix, suffix))" ] }, { "cell_type": "markdown", + "source": [ + "While it is Python syntax, you can see that the original model has no understanding of what a `LoraConfig` should be doing." + ], "metadata": { "id": "Pwy2ZC7U8Ema" - }, - "source": [ - "در حالی که خروجی، سینتکس پایتون است، اما همانطور که می بینید، مدل اصلی هیچ درکی از کارکرد یک `LoraConfig` ندارد." - ] + } }, { "cell_type": "markdown", + "source": [ + "To learn how this kind of fine-tuning compares to full fine-tuning, and how to use a model like this as your copilot in VS Code via Inference Endpoints, or locally, check out the [\"Personal Copilot: Train Your Own Coding Assistant\" blog post](https://huggingface.co/blog/personal-copilot). This notebook complements the original blog post.\n" + ], "metadata": { "id": "CATYE8pp2drQ" - }, - "source": [ - "در حالی که خروجی، سینتکس پایتون است، اما همانطور که می بینید، مدل اصلی هیچ درکی از کارکرد یک LoraConfig ندارد.\n", - "\n", - "برای اینکه چگونگی عملکرد این نوع تنظیم دقیق را با تنظیم دقیق کامل مقایسه کنید و همچنین نحوه استفاده از چنین مدلی به عنوان copilot در VS Code از طریق Inference Endpoints یا به صورت محلی را بیاموزید، به پست وبلاگ [ \"Personal Copilot: Train Your Own Coding Assistant\"](https://huggingface.co/blog/personal-copilot) مراجعه کنید. این دفترچه، مکمل پست وبلاگ اصلی است." - ] + } } - ], - "metadata": { - "accelerator": "GPU", - "colab": { - "gpuType": "A100", - "machine_shape": "hm", - "provenance": [] - }, - "kernelspec": { - "display_name": "Python 3 (ipykernel)", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.9.13" - } - }, - "nbformat": 4, - "nbformat_minor": 1 + ] } diff --git a/notebooks/fa/fine_tuning_code_llm_on_single_gpu.ipynb b/notebooks/fa/fine_tuning_code_llm_on_single_gpu.ipynb index 000cbd41..dddc04b5 100644 --- a/notebooks/fa/fine_tuning_code_llm_on_single_gpu.ipynb +++ b/notebooks/fa/fine_tuning_code_llm_on_single_gpu.ipynb @@ -10,18 +10,18 @@ "\n", "_نویسنده: [Maria Khalusova](https://github.com/MKhalusova)_\n", "\n", - "مدل‌های زبانی بزرگ‌ (LLM) عمومیِ مبتنی بر کد از جمله Codex, StarCoder و CodeLlama در تولید کدهایی که از اصول کلی برنامه ‌نویسی و سینتکس پیروی می کنند عالی هستند، اما ممکن است با قراردادهای داخلی سازمان مطابقت نداشته باشند یا از کتابخانه های اختصاصی مطلع نباشند.\n", + "مدل‌های زبانی بزرگ‌ ‫(LLM) عمومیِ مبتنی بر کد از جمله Codex ،StarCoder و CodeLlama در تولید کدهایی که از اصول کلی برنامه ‌نویسی و سینتکس برنامه‌نویسی پیروی می کنند عالی هستند، اما ممکن است با قراردادهای داخلی سازمان مطابقت نداشته باشند یا از کتابخانه های اختصاصی مطلع نباشند.\n", "\n", - "در این دفترچه، نحوه تنظیم دقیق (fine-tune) یک LLM مبتنی بر کد بر روی کد‌های خصوصی ‌را برای بهبود آگاهی زمینه‌ای آن و افزایش مفید بودن مدل برای نیازهای سازمان شما نشان خواهیم داد. از آنجایی که LLM های مبتنی بر کد بسیار بزرگ هستند، تنظیم دقیق آنها به روش سنتی می‌تواند از نظر منابع پر‌مصرف باشد. نگران نباشید! ما نحوه بهینه سازی تنظیم دقیق را برای جایگذاری روی یک هسته GPU نشان خواهیم داد.\n", + "در این دفترچه، نحوه تنظیم دقیق ‫(fine-tune) یک LLM مبتنی بر کد، بر روی کد‌های خصوصی ‌را برای بهبود فهم بافتاری آن در متن و افزایش کاربرد مدل برای نیازهای به‌ خصوص سازمان شما نشان خواهیم داد. از آنجایی که LLM های مبتنی بر کد بسیار بزرگ هستند، تنظیم دقیق آنها به روش سنتی می‌تواند از نظر منابع پر‌مصرف باشد. نگران نباشید! ما نحوه بهینه سازی تنظیم دقیق را بر روی یک هسته GPU نشان خواهیم داد.\n", "\n", "## دیتاست\n", "\n", - "برای این مثال، ما ۱۰ ریپازیتوری عمومی برتر Hugging Face را از Github انتخاب کردیم. ما فایل‌های غیر کد مانند تصاویر، فایل‌های صوتی، ارائه‌ها و غیره را از داده‌ها حذف کرده‌ایم. برای Jupyter Notebook ها، ما فقط سلول‌هایی را که حاوی کد هستند نگه داشته‌ایم. کد حاصل به عنوان دیتاستی ذخیره می‌شود که آن را در Hugging Face Hub تحت [`smangrul/hf-stack-v1`](https://huggingface.co/datasets/smangrul/hf-stack-v1) پیدا کنید. این دیتاست شامل شناسه ریپازیتوری، مسیر فایل و محتوای فایل است. \n", + "برای این مثال، ما ۱۰ ریپازیتوری عمومی برتر ‫Hugging Face را از Github انتخاب کردیم. ما فایل‌های غیر کد مانند تصاویر، فایل‌های صوتی، ارائه‌ها و غیره را از داده‌ها حذف کرده‌ایم. برای Jupyter Notebook ها، ما فقط سلول‌هایی را که حاوی کد هستند نگه داشته‌ایم. کد حاصل به عنوان دیتاستی ذخیره می‌شود که می‌توانید آن را در Hugging Face Hub تحت [`smangrul/hf-stack-v1`](https://huggingface.co/datasets/smangrul/hf-stack-v1) پیدا کنید. این دیتاست شامل شناسه ریپازیتوری، مسیر فایل و محتوای فایل است. \n", "\n", "\n", "## مدل\n", "\n", - "ما مدل [`bigcode/starcoderbase-1b`](https://huggingface.co/bigcode/starcoderbase-1b) که یک مدل با یک میلیارد پارامتر است و روی بیش از ۸۰ زبان برنامه نویسی آموزش دیده است را تنظیم دقیق می‌کنیم. دسترسی به این مدل محدود است، بنابرین اگر قصد دارید این دفترچه را با همین مدل اجرا کنید، باید از صفحه مدل به آن دسترسی پیدا کنید. برای انجام این کار، با حساب کاربری Hugging Face خود وارد شوید." + "ما مدل ‫[`bigcode/starcoderbase-1b`](https://huggingface.co/bigcode/starcoderbase-1b) که یک مدل با یک میلیارد پارامتر است و روی بیش از ۸۰ زبان برنامه نویسی آموزش دیده است را تنظیم دقیق می‌کنیم. دسترسی به این مدل محدود است، بنابرین اگر قصد دارید این دفترچه را با همین مدل اجرا کنید، باید از صفحه مدل به آن دسترسی پیدا کنید. برای انجام این کار، با حساب کاربری Hugging Face خود وارد شوید." ] }, { @@ -65,7 +65,7 @@ "id": "16EdABzt3_Ig" }, "source": [ - "اکنون چند متغیر تعریف می‌کنیم. در بازی کردن با مقدار این متغیر‌ها راحت باشید." + "اکنون چند متغیر تعریف می‌کنیم. در بازی کردن با این متغیر‌ها و تعویض مقدار آنها راحت باشید." ] }, { @@ -150,9 +150,9 @@ "id": "1LmrIZqP0oUE" }, "source": [ - "با بارگذاری داده شروع کنید. از آنجایی که به احتمال زیاد دیتاست بسیار بزرگ است، حتما حالت استریم (streaming) را فعال کنید. استریم به ما این امکان را می‌دهد که داده‌ها را به تدریج در حالی که روی دیتاست تکرار می‌کنیم، بارگذاری کنیم به جای اینکه کل دیتاست را به طور همزمان دانلود کنیم.\n", + "با بارگذاری داده شروع کنید. از آنجایی که به احتمال زیاد دیتاست بسیار بزرگ است، حتما حالت استریم ‫(streaming) را فعال کنید. استریم به ما این امکان را می‌دهد که داده‌ها را به تدریج در حالی که روی دیتاست تکرار می‌کنیم، بارگذاری کنیم به جای اینکه کل دیتاست را به طور یکجا دانلود کنیم.\n", "\n", - "ما ۴۰۰۰ نمونه اول را به عنوان دیتاست اعتبارسنجی (validation set) اختصاص خواهیم داد و باقی‌مانده به عنوان داده‌های آموزشی در نظر گرفته می‌شود." + "ما ۴۰۰۰ نمونه اول را به عنوان دیتاست اعتبارسنجی ‫(validation set) اختصاص خواهیم داد و باقی‌مانده به عنوان داده‌های آموزشی در نظر گرفته می‌شود." ] }, { @@ -186,11 +186,11 @@ "id": "sLQ8t0LM2GR6" }, "source": [ - "**تبدیلات اختیاری FIM (مدل پرکردن میانی)**\n", + "**تبدیلات اختیاری ‫FIM (اختیاری - مدل پرکردن میانی)**\n", "\n", - "مدل‌های زبان خودبازگشت (Autoregressive) معمولا توالی‌ها را از چپ به راست تولید می‌کنند. با اعمال تبدیلات FIM، مدل همچنین می‌تواند یاد بگیرد که متن را در بخش‌های میانی پر کند. برای اطلاعات بیشتر در مورد این تکنیک، به مقاله‌ی [Efficient Training of Language Models to Fill in the Middle](https://arxiv.org/pdf/2207.14255.pdf) مراجعه کنید.\n", + "مدل‌های زبان خودبازگشت ‫(Autoregressive) معمولا توالی‌ها را از چپ به راست تولید می‌کنند. با اعمال تبدیلات FIM، مدل همچنین می‌تواند یاد بگیرد که متن را در بخش‌های میانی پر کند. برای اطلاعات بیشتر در مورد این تکنیک، به مقاله‌ی [Efficient Training of Language Models to Fill in the Middle](https://arxiv.org/pdf/2207.14255.pdf) مراجعه کنید.\n", "\n", - "ما در اینجا تبدیلات FIM را تعریف می‌کنیم و هنگام ایجاد دیتاست قابل تکرار (Iterable Dataset) از آن‌ها استفاده خواهیم کرد. با این حال، اگر می‌خواهید تبدیلی صورت نگیرد، می‌توانید پارامتر fim_rate را روی ۰ تنظیم کنید." + "ما در اینجا تبدیلات ‫FIM را تعریف می‌کنیم و هنگام ایجاد دیتاست قابل تکرار (Iterable Dataset) از آن‌ها استفاده خواهیم کرد. با این حال، اگر می‌خواهید تبدیلی صورت نگیرد، می‌توانید پارامتر fim_rate را روی ۰ تنظیم کنید." ] }, { @@ -261,12 +261,12 @@ "id": "rcwYFRPpwxea" }, "source": [ - "**تبدیلات اختیاری FIM (مدل پرکردن میانی)**\n", + "**تبدیلات ‫FIM (اختیاری)**\n", "\n", "\n", - "مدل‌های زبان خودبازگشت (Autoregressive) معمولا توالی‌ها را از چپ به راست تولید می‌کنند. با اعمال تبدیلات FIM، مدل همچنین می‌تواند یاد بگیرد که متن را در بخش‌های میانی پر کند. برای اطلاعات بیشتر در مورد این تکنیک، به مقاله‌ی \"آموزش کارآمد مدل‌های زبان برای پر کردن بخش میانی\" (Efficient Training of Language Models to Fill in the Middle): https://arxiv.org/pdf/2207.14255.pdf مراجعه کنید.\n", + "مدل‌های زبان خودبازگشت ‫(Autoregressive) معمولا توالی‌ها را از چپ به راست تولید می‌کنند. با اعمال تبدیلات FIM، مدل همچنین می‌تواند یاد بگیرد که متن را در بخش‌های میانی پر کند. برای اطلاعات بیشتر در مورد این تکنیک، به مقاله‌ی \" [آموزش کارآمد مدل‌های زبان برای پر کردن بخش میان](https://arxiv.org/pdf/2207.14255.pdf) \"مراجعه کنید.\n", "\n", - "ما در اینجا تبدیلات FIM را تعریف می‌کنیم و هنگام ایجاد دیتاست قابل تکرار (Iterable Dataset) از آن‌ها استفاده خواهیم کرد. با این حال، اگر می‌خواهید تبدیلی صورت نگیرد، می‌توانید پارامتر fim_rate را روی ۰ تنظیم کنید." + "ما در اینجا تبدیلات ‫FIM را تعریف می‌کنیم و هنگام ایجاد دیتاست قابل تکرار (Iterable Dataset) از آن‌ها استفاده خواهیم کرد. با این حال، اگر می‌خواهید تبدیلی صورت نگیرد، می‌توانید پارامتر fim_rate را روی ۰ تنظیم کنید." ] }, { @@ -375,9 +375,9 @@ "id": "AwW5FviD9xBH" }, "source": [ - "بیایید ConstantLengthDataset را تعریف کنیم، یک دیتاست قابل تکرار که قطعاتی با طول ثابت از توکن‌ها را برمی‌گرداند. برای انجام این کار، بافر متنی را از مجموعه داده اصلی می‌خوانیم تا به محدودیت‌های اندازه برسیم و سپس از توکنایزر برای تبدیل متن خام به ورودی‌های توکن شده استفاده می‌کنیم. به صورت اختیاری، ما تبدیلات FIM را روی برخی از توالی‌ها انجام می‌دهیم (نسبت توالی‌های تحت تاثیر پارامتر fim_rate کنترل می‌شود).\n", + "بیایید ‫ConstantLengthDataset را تعریف کنیم، یک دیتاست قابل تکرار که قطعاتی با طول ثابت از توکن‌ها را برمی‌گرداند. برای انجام این کار، بافر متنی را از مجموعه داده اصلی می‌خوانیم تا به محدودیت‌های اندازه برسیم و سپس از توکنایزر برای تبدیل متن خام به ورودی‌های توکنیزه شده استفاده می‌کنیم. به صورت اختیاری، ما تبدیلات FIM را روی برخی از توالی‌ها انجام می‌دهیم (نسبت توالی‌های تحت تاثیر پارامتر fim_rate کنترل می‌شود).\n", "\n", - "پس از تعریف، می‌توانیم نمونه‌هایی از ConstantLengthDataset را هم از داده‌های آموزشی و هم از داده‌های اعتبارسنجی ایجاد کنیم." + "پس از تعریف، می‌توانیم نمونه‌هایی از ‫ConstantLengthDataset را هم از داده‌های آموزشی و هم از داده‌های اعتبارسنجی ایجاد کنیم." ] }, { @@ -534,17 +534,17 @@ "id": "UCtWV-U42Eq_" }, "source": [ - "حالا که داده‌ها آماده شدند، زمان بارگذاری مدل است! ما قصد داریم نسخه کوانتیده شده‌ی مدل را بارگذاری کنیم.\n", + ".حالا که داده‌ها آماده شدند، زمان بارگذاری مدل است! ما قصد داریم نسخه کوانتیده شده‌ی مدل را بارگذاری کنیم\n", "\n", - "کوانتیز‌ه‌سازی باعث کاهش استفاده از حافظه می‌شود، زیرا داده‌ها را با بیت‌های کمتری نمایش می‌دهد. برای کوانتیزه‌سازی مدل از کتابخانه‌ی bitsandbytes استفاده خواهیم کرد، زیرا این کتابخانه با transformers یکپارچگی خوبی دارد. تنها کاری که باید انجام دهیم پیکربندی اولیه bitsandbytes است و سپس می‌توانیم هنگام بارگذاری مدل از آن استفاده کنیم.\n", + "کوانتیز‌ه‌سازی باعث کاهش استفاده از حافظه می‌شود، زیرا داده‌ها را با بیت‌های کمتری نمایش می‌دهد. برای کوانتیزه‌سازی مدل از کتابخانه‌ی ‫bitsandbytes استفاده خواهیم کرد، زیرا این کتابخانه با transformer ها یکپارچگی خوبی دارد. تنها کاری که باید انجام دهیم پیکربندی اولیه bitsandbytes است و سپس می‌توانیم هنگام بارگذاری مدل از آن استفاده کنیم.\n", "\n", - "انواع مختلفی از کوانتیزه‌سازی ۴ بیتی وجود دارد، اما به طور کلی، ما برای عملکرد بهتر استفاده از کوانتیزه‌سازی NF4 را توصیه می‌کنیم (`bnb_4bit_quant_type=\"nf4\"`).\n", + "انواع مختلفی از کوانتیزه‌سازی ۴ بیتی وجود دارد، اما به طور کلی، ما برای عملکرد بهتر استفاده از کوانتیزه‌سازی ‫NF4 را توصیه می‌کنیم (`bnb_4bit_quant_type=\"nf4\"`).\n", "\n", "گزینه‌ی `bnb_4bit_use_double_quant` یک کوانتیزه‌سازی دوم را پس از کوانتیزه‌سازی اول اضافه می‌کند تا ۰.۴ بیت اضافی به ازای هر پارامتر ذخیره شود.\n", "\n", "برای اطلاعات بیشتر در مورد کوانتیزه‌سازی، به پست وبلاگ [\"Making LLMs even more accessible with bitsandbytes, 4-bit quantization and QLoRA\"](https://huggingface.co/blog/4bit-transformers-bitsandbytes) مراجعه کنید.\n", "\n", - "پس از تعریف پیکربندی، آن را به متد from_pretrained ارسال کنید تا نسخه کوانتیده شده‌ی مدل بارگذاری شود." + "پس از تعریف پیکربندی، آن را به متد ‫from_pretrained ارسال کنید تا نسخه کوانتیده شده‌ی مدل بارگذاری شود." ] }, { @@ -589,7 +589,7 @@ "id": "bO9e2FV8D8ZF" }, "source": [ - "برای استفاده از یک مدل کوانتیده شده جهت آموزش، لازم است تابع `prepare_model_for_kbit_training` را فراخوانی کنید تا مدل کوانتیده شده را برای آموزش آماده‌سازی کند." + "برای استفاده از یک مدل کوانتیده شده جهت آموزش، لازم است تابع ‫`prepare_model_for_kbit_training` را فراخوانی کنید تا مدل کوانتیده شده را برای آموزش آماده‌سازی کند." ] }, { @@ -609,11 +609,11 @@ "id": "lmnLjPZpDVtg" }, "source": [ - "حالا که مدل کمی سازی شده آماده است، می توانیم پیکربندی LoRA را تنظیم کنیم. LoRA با کاهش چشمگیر تعداد پارامترهای قابل آموزش، فرآیند تنظیم دقیق را کارآمدتر می کند.\n", + "حالا که مدل کمی سازی شده آماده است، می توانیم پیکربندی ‫LoRA را تنظیم کنیم. LoRA با کاهش چشمگیر تعداد پارامترهای قابل آموزش، فرآیند تنظیم دقیق را کارآمدتر می کند.\n", "\n", - "برای آموزش یک مدل با استفاده از تکنیک LoRA، باید مدل پایه را به عنوان یک `PeftModel` بپوشانیم. این شامل تعریف پیکربندی LoRA با `LoraConfig` و پوشاندن مدل اصلی با `get_peft_model()` با استفاده از `LoraConfig` است.\n", + "برای آموزش یک مدل با استفاده از تکنیک ‫LoRA، باید مدل پایه را به عنوان یک `PeftModel` بپوشانیم. این شامل تعریف پیکربندی LoRA با `LoraConfig` و پوشاندن مدل اصلی با `get_peft_model()` با استفاده از `LoraConfig` است.\n", "\n", - "برای کسب اطلاعات بیشتر در مورد LoRA و پارامترهای آن، به مستندات [PEFT documentation](https://huggingface.co/docs/peft/conceptual_guides/lora) مراجعه کنید." + "برای کسب اطلاعات بیشتر در مورد ‫LoRA و پارامترهای آن، به مستندات [PEFT documentation](https://huggingface.co/docs/peft/conceptual_guides/lora) مراجعه کنید." ] }, { @@ -656,7 +656,7 @@ "id": "tHe7AElXzXVV" }, "source": [ - "همانطور که مشاهده می کنید، با به کارگیری تکنیک LoRA، اکنون نیاز به آموزش کمتر از ۱ درصد از پارامترها خواهیم داشت." + "همانطور که مشاهده می کنید، با به کارگیری تکنیک ‫LoRA، اکنون نیاز به آموزش کمتر از ۱ درصد از پارامترها خواهیم داشت." ] }, { @@ -674,11 +674,11 @@ "id": "Q_iN2khjrbD3" }, "source": [ - "حالا که داده ها را آماده کرده ایم و مدل را بهینه کرده ایم، آماده ایم تا همه چیز کنار هم آورده و آموزش را شروع کنیم.\n", + "حالا که داده ها را آماده کرده ایم و مدل را بهینه کرده ایم، آماده ایم تا همه چیز را کنار هم آورده و آموزش مدل را شروع کنیم.\n", "\n", - "برای ایجاد یک `Trainer`، باید پیکربندی آموزش را تعریف کنید. مهمترین بخش `TrainingArguments` است، کلاسی که شامل تمام ویژگی های پیکربندی آموزش می شود.\n", + "برای ایجاد یک ‫`Trainer`، باید پیکربندی آموزش را تعریف کنید. مهمترین بخش `TrainingArguments` است، کلاسی که شامل تمام ویژگی های پیکربندی آموزش می شود.\n", "\n", - "این موارد مشابه هر نوع آموزش مدل دیگری هستند که ممکن است اجرا کنید، بنابراین در اینجا به جزئیات نمی‌پردازیم." + "این موارد مشابه هر نوع فرآیند آموزش مدل دیگری هستند که قبلا اجرا کرده‌اید،‫ بنابراین در اینجا به جزئیات نمی‌پردازیم." ] }, { @@ -722,7 +722,7 @@ "id": "kB_fLRex09ut" }, "source": [ - "به عنوان آخرین مرحله، `Trainer` را ایجاد کرده و متد `train` را فراخوانی کنید." + "به عنوان آخرین مرحله، ‫`Trainer` را ایجاد کرده و متد ‫`train` را فراخوانی کنید." ] }, { @@ -918,9 +918,9 @@ "id": "KBVH7uFOM_UF" }, "source": [ - "## استنتاج (Inference)\n", + "## استنتاج ‫(Inference)\n", "\n", - "بعد از اینکه مدل بر روی هاب آپلود شد، می‌توانیم برای استنتاج از آن استفاده کنیم. برای انجام این کار، ابتدا مدل پایه اصلی و توکنایزر آن را مقداردهی اولیه می‌کنیم. سپس، نیاز داریم تا وزن‌های تنظیم‌ دقیق شده را با مدل پایه ادغام (merge) کنیم." + "بعد از اینکه مدل بر روی هاب آپلود شد، می‌توانیم برای استنتاج از آن استفاده کنیم. برای انجام این کار، ابتدا مدل پایه اصلی و توکنایزر آن را مقداردهی اولیه می‌کنیم. سپس، نیاز داریم تا وزن‌های تنظیم‌ دقیق شده را با مدل پایه ادغام ‫(merge) کنیم." ] }, { @@ -956,7 +956,7 @@ "id": "3USQ2suvDi9M" }, "source": [ - "حالا می‌توانیم از مدل ادغام‌شده برای استنتاج استفاده کنیم. برای سهولت، ما یک تابع به نام `get_code_completion` تعریف می‌کنیم - در تغییر پارامترهای تولید متن راحت باشید!" + "حالا می‌توانیم از مدل ادغام‌شده برای استنتاج استفاده کنیم. برای سهولت، ما یک تابع به نام ‫`get_code_completion` تعریف می‌کنیم - در تغییر پارامترهای تولید متن راحت باشید!" ] }, { @@ -988,7 +988,7 @@ "id": "0kMJiGDfDrBf" }, "source": [ - "حال برای دریافت ویژگی کد تکمیل‌ شونده، تنها کاری که باید انجام دهیم فراخوانی تابع `get_code_complete` است. ورودی‌های این تابع چند خط اولی که می‌خواهید تکمیل شوند به عنوان پیشوند و یک رشته خالی به عنوان پسوند هستند " + "حال برای دریافت ویژگی کد تکمیل‌ شونده، تنها کاری که باید انجام دهیم فراخوانی تابع ‫`get_code_complete` است. ورودی‌های این تابع چند خط اولی که می‌خواهید تکمیل شوند به عنوان پیشوند و یک رشته خالی به عنوان پسوند هستند." ] }, { @@ -1040,9 +1040,9 @@ "id": "Ql2563kGlnmu" }, "source": [ - "همانطور که مشاهده کردید، به عنوان شخصی که در این دفترچه از کتابخانه PEFT استفاده کردید، نتیجه تولید شده برای ایجاد یک `LoraConfig` بسیار خوب است!\n", + "همانطور که مشاهده کردید، به عنوان شخصی که در این دفترچه از کتابخانه ‫PEFT استفاده کردید، نتیجه تولید شده برای ایجاد یک `LoraConfig` بسیار خوب است!\n", "\n", - "اگر به سلولی که مدل را برای استنتاج ایجاد کردیم برگردید و خطوطی را که وزن‌های تنظیم‌ دقیق شده را ادغام می‌کنند کامنت کنید، می‌توانید ببینید که مدل اصلی برای همان پیشوند دقیقاً چه چیزی تولید می‌کرد:" + "اگر به سلولی که مدل را برای استنتاج ایجاد کردیم برگردید و خطوطی را که وزن‌های تنظیم‌ دقیق شده را ادغام می‌کنند کامنت کنید، می‌توانید ببینید که مدل اصلی برای همان پیشوند دقیقاً چه چیزی تولید می‌کرد‫." ] }, { @@ -1091,21 +1091,19 @@ { "cell_type": "markdown", "metadata": { - "id": "Pwy2ZC7U8Ema" + "id": "CATYE8pp2drQ" }, "source": [ - "در حالی که خروجی، سینتکس پایتون است، اما همانطور که می بینید، مدل اصلی هیچ درکی از کارکرد یک `LoraConfig` ندارد." + "در حالی که خروجی، سینتکس پایتون است، اما همانطور که می بینید، مدل اصلی هیچ درکی از کارکرد یک ‫LoraConfig ندارد.\n" ] }, { "cell_type": "markdown", - "metadata": { - "id": "CATYE8pp2drQ" - }, + "metadata": {}, "source": [ - "در حالی که خروجی، سینتکس پایتون است، اما همانطور که می بینید، مدل اصلی هیچ درکی از کارکرد یک LoraConfig ندارد.\n", + "برای اینکه چگونه عملکرد این نوع تنظیم دقیق را با تنظیم دقیق کامل مقایسه کنید و برای آموختن چگونگی استفاده از چنین مدلی به عنوان دستیار-شخصی در ‫ vscode از طریق Inference Endpoints یا به صورت محلی، به پست وبلاگ [\"Personal Copilot: Train Your Own Coding Assistant\"](https://huggingface.co/blog/personal-copilot) مراجعه کنید.\n", "\n", - "برای اینکه چگونگی عملکرد این نوع تنظیم دقیق را با تنظیم دقیق کامل مقایسه کنید و همچنین نحوه استفاده از چنین مدلی به عنوان copilot در VS Code از طریق Inference Endpoints یا به صورت محلی را بیاموزید، به پست وبلاگ [ \"Personal Copilot: Train Your Own Coding Assistant\"](https://huggingface.co/blog/personal-copilot) مراجعه کنید. این دفترچه، مکمل پست وبلاگ اصلی است." + "این دفترچه، مکمل پست وبلاگ اصلی است." ] } ],