Data scientist sedang berada dalam posisi yang menarik; meskipun pekerjaan mereka di era modern mengharuskan mereka menggunakan bahasa pemrograman, masih banyak aspek bisnis yang perlu diingat.
Itulah sebabnya kode Python yang digunakan oleh data scientist biasanya mencerminkan cerita tentang cara menyelesaikan masalah bisnis. Lingkungan kerja data scientist juga luar biasa; kita menggunakan IDE Jupyter Notebook, yang memungkinkan cara yang sangat baik untuk bereksperimen dengan manipulasi data dan pengembangan model.
Dengan cara coding yang berbeda, data scientist akan melakukan beberapa hal berbeda selama aktivitas pemrograman. Ini termasuk aktivitas memberi komentar, yang merupakan kegiatan untuk menjelaskan kode Anda. Bagi data scientist yang sering mengalami perubahan kebutuhan dan bekerja secara kolaboratif, sangat penting untuk memberikan penjelasan yang memadai tentang kode melalui komentar.
Artikel ini akan membahas bagaimana cara memberikan komentar pada kode Python sebagai data scientist. Kita akan membahas berbagai poin yang akan meningkatkan aktivitas Anda dan memberikan nilai bagi siapa pun yang membaca kode Anda. Mari kita bahas lebih lanjut.
Jenis-Jenis Komentar
Sebelum kita melangkah lebih jauh, mari kita pelajari sedikit tentang dua jenis komentar yang berbeda. Yang pertama adalah komentar satu baris (single-line commenting), yang menggunakan notasi ‘#’ dalam kode. Biasanya digunakan untuk penjelasan sederhana tentang kode. Misalnya, kode di bawah ini mencontohkan penggunaan komentar satu baris.
# Kode ini untuk mengimpor paket Pandas dan menyebutnya sebagai pd
import pandas as pdCara lain untuk memberikan komentar adalah menggunakan metode multi-baris, yang menggunakan triple quotes (tanda kutip tiga).
Secara teknis, ini bukan komentar melainkan objek string, tetapi Python akan mengabaikannya jika kita tidak menetapkannya ke variabel. Kita bisa melihatnya dengan contoh berikut.
"""Kode ini untuk mengimpor paket Pandas dan menyebutnya sebagai pd"""
import pandas as pdTips Umum untuk Menulis Komentar
Pada bagian ini, kita akan membahas beberapa tips umum untuk memberi komentar. Ini tidak hanya berlaku untuk data scientist karena tips ini adalah best practice untuk pemrograman, tetapi ini bagus untuk diingat. Tipsnya adalah:
Pertimbangkan untuk meletakkan komentar di baris terpisah tepat di atas kode yang ingin kita jelaskan untuk meningkatkan keterbacaan.
Konsisten dalam gaya komentar di seluruh kode yang Anda kerjakan.
Hindari menggunakan jargon dan istilah teknis yang sulit dipahami jika Anda tahu audiensnya tidak akan memahaminya.
Beri komentar hanya jika itu menambah nilai agar menghindari menjelaskan sesuatu yang sudah jelas.
Jaga dan perbarui komentar jika sudah tidak relevan lagi.
Ini adalah pedoman umum untuk memberikan pengalaman menulis komentar yang lebih baik. Sekarang, mari kita beralih ke yang lebih spesifik untuk data scientist.
Tips Menulis Komentar untuk Data Scientist
Untuk data scientist, aktivitas codingnya akan berbeda dari software engineer atau web developer. Itulah mengapa akan ada perbedaan dalam aktivitas menulis komentar. Berikut beberapa tips yang khusus untuk kita data scientist.
1. Gunakan Komentar untuk Menjelaskan Proses atau Aktivitas yang Kompleks
Aktivitas data science akan melibatkan banyak proses eksperimental yang mungkin membingungkan pembaca atau diri kita sendiri di masa depan jika kita tidak menjelaskannya.
Komentar pada kode akan membantu kita menjelaskan maksud kita dengan lebih baik, terutama jika melibatkan banyak langkah. Misalnya, kode di bawah ini akan menjelaskan cara kita menghapus outlier dengan normalisasi dan scaling.
# Lakukan normalisasi data (Min-Max scaling)
normalized_data = (data - np.min(data)) / (np.max(data) - np.min(data))
# Hapus outlier dengan menggunakan aturan sigma (3 standard deviations removal)
removed_outlier_data = normalized_data[np.abs(stats.zscore(normalized_data)) < 3]Komentar di atas menjelaskan apa yang dilakukan untuk setiap proses dan konsep di baliknya. Menjelaskan konsep yang kita gunakan dalam kode sangat penting untuk memahami apa yang telah kita lakukan.
Ini tidak terbatas pada preprocessing tetapi kita bisa memberi komentar pada setiap langkah data science. Dari pengambilan data hingga pemantauan model, memberi komentar untuk dipahami oleh siapa saja adalah praktik yang baik. Ingatlah bahwa sebagai data scientist, komentar kita bisa menjadi jembatan antara kode dan wawasan analitis.
2. Memiliki Standar Komentar
Aktivitas data science adalah proses kolaborasi, jadi memiliki struktur standar yang semua orang mengerti itu bagus. Ini juga bermanfaat bahkan jika Anda bekerja sendiri, karena Anda memiliki standar yang Anda pahami. Misalnya, Anda bisa membuat standar komentar untuk setiap fungsi yang Anda buat.
# Function: nama fungsi
# Usage: deskripsi cara menggunakan fungsi tersebut
# Parameters: daftar parameter dan jelaskan
# Output: menjelaskan output-nyaDi atas adalah contoh standar, karena Anda dapat membuat sesuatu secara mandiri. Jangan lupa untuk menggunakan gaya, bahasa, dan singkatan yang sama ketika Anda memiliki standar seperti ini.
3. Gunakan Komentar untuk Membantu Workflow
Dalam lingkungan kolaboratif, memberi komentar sangat penting untuk membantu tim memahami Workflow. Kita bisa menggunakan komentar untuk membantu memahami ketika ada pembaruan kode baru atau apa yang perlu dilakukan selanjutnya.
Misalnya, pembaruan pada fungsi lain menyebabkan bug dalam proses kita, jadi langkah selanjutnya kita perlu memperbaiki bug tersebut.
# TODO: Perbaiki fungsi ini secepatnya
some_function_to_fix()4. Implementasikan Sel Markdown pada Notebook
IDE Data Scientist sangat luar biasa karena kita menggunakan Notebook untuk eksperimen. Dengan menggunakan sel dalam notebook, kita bisa mengisolasi setiap kode sehingga kode tersebut bisa dijalankan secara independen tanpa perlu menjalankan seluruh kode. Sel notebook tidak terbatas pada kode tetapi bisa diubah menjadi sel Markdown.
Markdown adalah bahasa pemformatan yang menjelaskan bagaimana teks seharusnya terlihat. Dalam sel, markdown dapat menjelaskan kode di bawahnya. Keuntungan menggunakan Markdown adalah kita dapat berkomentar lebih detail daripada proses komentar standar. Anda bahkan dapat menambahkan tabel, gambar, LaTeX, dan lain sebagainya.
Sebagai contoh, gambar di bawah ini menunjukkan bagaimana kita menggunakan Markdown untuk menjelaskan proyek kita, tujuan dan langkah-langkahnya.
Anda bisa membaca lebih lanjut tentang sel Jupyter Markdown dalam dokumentasi mereka untuk memahami lebih lanjut apa yang bisa Anda lakukan.
Kesimpulan
Menulis komentar adalah bagian integral dari aktivitas data scientist karena membantu pembaca memperjelas apa yang terjadi dengan kode. Bagi data scientist, proses menulis komentar sedikit berbeda dari software engineer atau web developer, karena proses kerja kita berbeda. Itulah mengapa artikel ini memberikan beberapa tips yang bisa Anda gunakan untuk menulis komentar sebagai data scientist. Tipsnya adalah:
Gunakan Komentar untuk Menjelaskan Proses atau Aktivitas yang Kompleks
Memiliki Standar Komentar
Gunakan Komentar untuk Membantu Workflow
Implementasikan Sel Markdown pada Notebook
Semoga bermanfaat.
Comments