I nazariy qism

Hujjatlarni yozish – spetsifikatsiya
Huggingface/transformers hujjatlari hujjatlar satrlari uchun Google hujjatlari uslubiga amal qiladi, ammo biz ularni to'g'ridan-to'g'ri Markdown-da yozishimiz mumkin.
Yangi qoʻllanma qoʻshilmoqda
Yangi qo'llanma yoki bo'lim qo'shish ikki bosqichda amalga oshiriladi:

• 
  Add a new file under ./source. This file can either be ReStructuredText (.rst) or Markdown (.md).
  
• 
  Link that file in ./source/_toctree.yml on the correct toc-tree.
  

Yangi faylni tegishli bo'lim ostiga qo'yganingizga ishonch hosil qiling. Birinchi bo'limga (Ishga kirishish) borish dargumon, shuning uchun mo'ljallangan maqsadlarga (yangi boshlanuvchilar, ilg'or foydalanuvchilar yoki tadqiqotchilar) qarab, u ikkinchi, uchinchi yoki to'rtinchi bo'limlarga o'tishi kerak.
Tarjima qilinmoqda
Tarjima qilayotganda, qo'llanmaga qarang ./TRANSLATING.md.
Usulda argumentlarni aniqlash

Argumentlar Args: (yoki Argumentlar: yoki Parameters:) prefiksi, undan keyin qator qaytishi va chekinish bilan belgilanishi kerak. Argumentdan keyin uning turi, agar u tenzor, yo'g'on ichak bo'lsa, shakli va tavsifi ko'rsatilishi kerak:

Args:
n_layers (`int`): The number of layers of the model.

Agar tavsif bir qatorga sig'maydigan darajada uzun bo'lsa, argumentdan keyin tavsifni yozishdan oldin yana bir chekinish kerak bo'ladi.

Hozirgacha hamma narsani ko'rsatadigan misol:

Args:
input_ids (`torch.LongTensor` of shape `(batch_size, sequence_length)`):
Indices of input sequence tokens in the vocabulary.


Indices can be obtained using [`AlbertTokenizer`]. See [`~PreTrainedTokenizer.encode`] and
[`~PreTrainedTokenizer.__call__`] for details.


[What are input IDs?](../glossary#input-ids)
Ixtiyoriy argumentlar yoki standart parametrlarga ega argumentlar uchun biz quyidagi sintaksisga amal qilamiz: tasavvur qiling-a, bizda quyidagi imzo bilan funksiya bor:


def my_function(x: str = None, a: float = 1):

unda uning hujjatlari quyidagicha ko'rinishi kerak:

Args:
x (`str`, *optional*):
This argument controls ...
a (`float`, *optional*, defaults to 1):
This argument is used to ...
E'tibor bering, biz har qanday argument uchun hech qanday standart bo'lmaganda, biz har doim "birlamchi qiymatlarni "Yo'q"ga o'tkazib yuboramiz. Shuni ham yodda tutingki, argument turini va uning standartini tavsiflovchi birinchi qator uzun bo'lsa ham, uni bir nechta satrlarda buzolmaydi. Shu bilan birga, chizilgan tavsifga xohlagancha qator yozishingiz mumkin (yuqoridagi input_ids misoliga qarang).