2.7 Dokumentacija

Nors negalime pristatyti kiekvienos MXNet funkcijos ir klasės (o informacija gali greitai pasenti), API dokumentacija ir papildomi vadovai bei pavyzdžiai suteikia tokią dokumentaciją. Šiame skyrelyje pateikiame šiek tiek patarimų, kaip tyrinėti MXNet API.

Nors negalime pristatyti kiekvienos PyTorch funkcijos ir klasės (o informacija gali greitai pasenti), API dokumentacija ir papildomi vadovai bei pavyzdžiai suteikia tokią dokumentaciją. Šiame skyrelyje pateikiame šiek tiek patarimų, kaip tyrinėti PyTorch API.

Nors negalime pristatyti kiekvienos TensorFlow funkcijos ir klasės (o informacija gali greitai pasenti), API dokumentacija ir papildomi vadovai bei pavyzdžiai suteikia tokią dokumentaciją. Šiame skyrelyje pateikiame šiek tiek patarimų, kaip tyrinėti TensorFlow API.

from mxnet import np

import torch

import tensorflow as tf

import jax

2.7.1 Modulio funkcijos ir klasės

Norėdami sužinoti, kurias funkcijas ir klases galima kviesti modulyje, iškviečiame funkciją dir. Pavyzdžiui, galime (užklausti visų atsitiktinių skaičių generavimo modulio savybių):

print(dir(np.random))

print(dir(torch.distributions))

print(dir(tf.random))

print(dir(jax.random))

Paprastai galime nepaisyti funkcijų, prasidedančių ir pasibaigiančių __ (specialūs Python objektai), arba funkcijų, prasidedančių vienu _ (paprastai vidinės funkcijos). Pagal likusius funkcijų ar atributų pavadinimus galime drįsti spėti, kad šis modulis siūlo įvairius atsitiktinių skaičių generavimo metodus, įskaitant atranką iš tolygiojo skirstinio (uniform), normaliojo skirstinio (normal) ir daugianario skirstinio (multinomial).

2.7.2 Konkrečios funkcijos ir klasės

Konkrečių nurodymų, kaip naudoti tam tikrą funkciją ar klasę, galime gauti iškviesdami funkciją help. Pavyzdžiui, panagrinėkime tenzorių funkcijos ones naudojimo instrukcijas.

help(np.ones)

help(torch.ones)

help(tf.ones)

help(jax.numpy.ones)

Iš dokumentacijos matome, kad funkcija ones sukuria naują tenzorių su nurodyta forma ir visus elementus nustato lygius 1. Kai tik įmanoma, turėtumėte (atlikti greitą bandymą), kad patvirtintumėte savo interpretaciją:

np.ones(4)

torch.ones(4)

tf.ones(4)

jax.numpy.ones(4)

„Jupyter" sąsiuvinyje galime naudoti ? dokumentui parodyti kitame lange. Pavyzdžiui, list? sukurs turinį, beveik identišką help(list), ir parodys jį naujame naršyklės lange. Be to, jei naudojame du klaustukus, pvz., list??, bus parodytas ir funkciją įgyvendinantis Python kodas.

Oficiali dokumentacija pateikia daug aprašymų ir pavyzdžių, kurie yra už šios knygos ribų. Pabrėžiame svarbius naudojimo atvejus, kurie leis jums greitai pradėti spręsti praktinius uždavinius, o ne aprėpties išsamumą. Taip pat skatiname studijuoti bibliotekų šaltinio kodą, kad pamatytumėte aukštos kokybės gamybinio kodo įgyvendinimo pavyzdžių. Tai darydami taptumėte geresniu inžinieriumi ir kartu geresniu mokslininku.

Diskusijos