Dokumentasi Resmi

Sepanjang Course ini kita banyak memakai contoh kode yang sudah disiapkan dan diuji. Begitu kita mengerjakan masalah sendiri, pertanyaan baru pasti bermunculan: parameter apa saja yang dimiliki read_csv(), kapan RandomForestClassifier lebih tepat daripada model lain, atau bagaimana cara memakai offset tanggal di pandas. Jawaban paling tepercaya untuk pertanyaan semacam itu bukan blog atau forum, melainkan dokumentasi resmi setiap library. Pada chapter ini kita belajar membaca dokumentasi resmi secara efektif: mengenali lapisannya, membedakannya dari materi tidak resmi, dan memanggilnya langsung dari dalam Python.

Tiga Lapis Dokumentasi yang Perlu Dikenali #

Hampir semua library besar menyusun dokumentasinya dalam tiga lapis yang punya tugas berbeda. Lapis pertama adalah quickstart atau getting started: panduan singkat untuk menghasilkan sesuatu dalam lima belas menit pertama. Lapis kedua adalah user guide: penjelasan konsep per topik, lengkap dengan contoh dan catatan perilaku. Lapis ketiga adalah API reference: daftar lengkap setiap class, fungsi, dan parameternya, disusun seperti ensiklopedia.

Urutan membacanya sebaiknya mengikuti urutan lapis tersebut, bukan langsung melompat ke API reference:

Kebiasaan melompat langsung ke API reference adalah penyebab utama dokumentasi terasa padat dan teknis. Halaman seperti itu memang ditulis untuk pembaca yang sudah memahami konsepnya, bukan untuk perkenalan. Sebaliknya, terus berdiam di quickstart membuat kita tidak pernah tahu kemampuan penuh library yang dipakai.

Dokumentasi Resmi versus Blog dan Tutorial #

Blog dan tutorial punya tempat yang sah dalam proses belajar, tetapi keduanya berbeda dari dokumentasi resmi dalam hal sumber dan umur. Dokumentasi resmi ditulis dan dijaga oleh tim yang mengembangkan library tersebut, sehingga setiap rilis baru disertai pembaruan dokumen. Blog ditulis individu pada satu titik waktu tertentu, sering kali untuk satu kasus spesifik, dan jarang dimutakhirkan ketika library berubah.

Pola yang sehat adalah memakai keduanya sesuai perannya: pahami konsep dan parameter dari dokumentasi resmi, lalu pakai blog sebagai sumber inspirasi untuk melihat bagaimana orang lain menyusun solusi nyata. Ketika keduanya bertentangan, dokumentasi resmi yang kita ikuti.

Peta Dokumentasi Library Inti #

Enam library berikut adalah alat utama kita sepanjang Course ini. Tabel ini memetakan halaman mana yang paling sering kita buka beserta situasinya:

Dua catatan kecil agar tabel di atas mudah dipakai. Pertama, scikit-learn juga menyusun user guide per topik (misalnya preprocessing dan evaluasi model) yang berdiri di antara FAQ dan API reference; kita petakan lebih rinci pada chapter Referensi Machine Learning . Kedua, halaman stats di SciPy berperan sebagai katalog: kita mencari distribusi atau uji yang sesuai lewat daftarnya, lalu membaca halaman detailnya.

Membaca Dokumentasi dari Dalam Python #

Dokumentasi tidak selalu harus dibuka lewat peramban. Setiap class dan fungsi publik menyimpan teks dokumentasinya di dalam paket sebagai docstring, sehingga bisa dibaca dari terminal sekalipun. Memanggil help(pd.DataFrame.head) pada sesi interaktif, atau dari terminal lewat python -c "import pandas as pd; help(pd.DataFrame.head)", akan mencetak docstring lengkap head().

import pandas as pd

print("Versi pandas terpasang:", pd.__version__)

# help() mencetak docstring penuh; kita ambil bagian atasnya saja
doc = pd.DataFrame.head.__doc__
for baris in [b.strip() for b in doc.splitlines() if b.strip()][:7]:
    print(baris)

Output yang Dihasilkan:

Versi pandas terpasang: 2.2.3
Return the first `n` rows.
This function returns the first `n` rows for the object based
on position. It is useful for quickly testing if your object
has the right type of data in it.
For negative values of `n`, this function returns all rows except
the last `|n|` rows, equivalent to ``df[:n]``.
If n is larger than the number of rows, this function returns all rows.

Mari kita telaah baris-baris kode di atas:

1. Baris 3 (print("Versi pandas ...")): kita mencetak versi pandas yang terpasang lebih dulu. Situs dokumentasi pandas menyediakan pemilih versi; memastikan versi dokumen sama dengan versi terpasang mencegah kita membaca perilaku yang tidak berlaku untuk kode kita sendiri.
2. Baris 6 (doc = pd.DataFrame.head.__doc__): atribut __doc__ berisi docstring head() — teks yang sama dengan yang dirender situs dokumentasi pada halaman API reference-nya.
3. Baris 7-8 (for baris in ...): docstring penuh head() panjang sekali karena memuat parameter, contoh, dan tautan silang. Kita menyaring baris kosong lalu mengambil tujuh baris pertama agar keluaran tetap ringkas untuk dicontohkan.

Rangkuman #

• Dokumentasi resmi tersusun tiga lapis: quickstart untuk perkenalan, user guide untuk konsep, API reference untuk detail parameter; bacalah dengan urutan tersebut.
• Dokumentasi resmi dijaga tim pengembang dan selalu mengikuti rilis, sedangkan blog bisa berhenti pada versi lama — gunakan keduanya sesuai perannya dan utamakan dokumentasi resmi saat bertentangan.
• Enam halaman inti yang paling sering kita buka: pandas User Guide, FAQ scikit-learn, NumPy absolute basics, pengguna matplotlib, modul stats SciPy, dan dokumentasi statsmodels.
• Docstring dapat dibaca langsung dari Python melalui help() atau __doc__, dan versi terpasang selalu perlu dicocokkan dengan versi dokumen.

Menguasai dokumentasi berarti kita mampu menjawab pertanyaan “bagaimana alat ini dipakai”. Pertanyaan berikutnya setelah alat dikuasai adalah “di mana bahan berlatihnya” — data. Kita petakan sumber-sumbernya pada chapter Dataset Terbuka.