วิธีแสดงความคิดเห็นรหัส Python ของคุณในฐานะนักวิทยาศาสตร์ข้อมูล – KDnuggets

รูปภาพที่สร้างโดย DALL·E 3
 

นักวิทยาศาสตร์ข้อมูลถูกจัดให้อยู่ในตำแหน่งที่น่าตื่นเต้น แม้ว่างานของพวกเขาในยุคสมัยใหม่จะต้องใช้ภาษาการเขียนโปรแกรม แต่ก็ยังมีแง่มุมทางธุรกิจอีกมากมายที่งานของพวกเขาต้องการจดจำ นั่นเป็นสาเหตุที่โค้ด Python ที่ Data Scientist ใช้มักจะสะท้อนถึงการเล่าเรื่องเกี่ยวกับวิธีการแก้ไขปัญหาทางธุรกิจ สภาพแวดล้อมสำหรับนักวิทยาศาสตร์ข้อมูลก็น่าทึ่งเช่นกัน เราใช้ Jupyter Notebook IDE ซึ่งช่วยให้มีวิธีที่ยอดเยี่ยมในการทดลองการจัดการข้อมูลและการพัฒนาโมเดล 

ด้วยวิธีการเขียนโค้ดที่แตกต่างกัน นักวิทยาศาสตร์ข้อมูลจะทำสิ่งที่แตกต่างออกไปในระหว่างกิจกรรมการเขียนโปรแกรม รวมถึงกิจกรรมการแสดงความคิดเห็นซึ่งเป็นกิจกรรมเพื่ออธิบายโค้ดของคุณ สำหรับนักวิทยาศาสตร์ข้อมูลที่มีการเปลี่ยนแปลงข้อกำหนดอยู่ตลอดเวลาและทำงานร่วมกัน การให้คำอธิบายที่เพียงพอของโค้ดผ่านการแสดงความคิดเห็นเป็นสิ่งสำคัญ

บทความนี้จะกล่าวถึงวิธีการแสดงความคิดเห็นโค้ด Python ในฐานะนักวิทยาศาสตร์ข้อมูล เราจะหารือเกี่ยวกับประเด็นต่างๆ ที่จะปรับปรุงกิจกรรมของคุณและนำคุณค่ามาสู่ทุกคนที่อ่านโค้ดของคุณ เรามาเข้าเรื่องกันเถอะ

ก่อนที่เราจะไปไกลกว่านั้น มาเรียนรู้เกี่ยวกับการแสดงความคิดเห็นสองประเภทกันก่อน รายการแรกคือการแสดงความคิดเห็นบรรทัดเดียว ซึ่งใช้เครื่องหมาย '#' สัญกรณ์ในรหัส โดยปกติจะใช้สำหรับการอธิบายโค้ดง่ายๆ ตัวอย่างเช่น โค้ดด้านล่างเป็นตัวอย่างการใช้งานการแสดงความคิดเห็นแบบบรรทัดเดียว

# The code is to import the Pandas package and call it pd
import pandas as pd

วิธีแสดงความคิดเห็นอีกวิธีหนึ่งคือการใช้วิธีหลายบรรทัด ซึ่งใช้เครื่องหมายคำพูดแบบสามบรรทัด ในทางเทคนิคแล้ว สิ่งเหล่านี้ไม่ใช่ความคิดเห็น แต่เป็นอ็อบเจ็กต์สตริง แต่ Python จะเพิกเฉยต่อมันหากเราไม่กำหนดให้กับตัวแปร เราจะเห็นการดำเนินการเหล่านี้ได้จากตัวอย่างต่อไปนี้

"""
The code below would import the Pandas package, and we would call them pd throughout the whole working environment. """
import pandas as pd

ในส่วนนี้ เราจะพูดถึงเคล็ดลับทั่วไปในการแสดงความคิดเห็น ไม่จำเป็นสำหรับนักวิทยาศาสตร์ข้อมูลเนื่องจากเคล็ดลับเหล่านี้เป็นแนวทางปฏิบัติที่ดีที่สุดสำหรับโปรแกรมเมอร์ แต่ก็ควรจำไว้ เคล็ดลับคือ:

1. ลองวางความคิดเห็นในบรรทัดแยกเหนือโค้ดที่เราต้องการอธิบายโดยตรงเพื่อเพิ่มความสามารถในการอ่าน
2. สอดคล้องกับรูปแบบการแสดงความคิดเห็นตลอดทั้งโค้ดที่คุณกำลังดำเนินการอยู่
3. หลีกเลี่ยงการใช้ศัพท์เฉพาะและคำศัพท์ทางเทคนิคที่เข้าใจยากหากคุณรู้ว่าผู้ฟังจะไม่เข้าใจ
4. แสดงความคิดเห็นเฉพาะในกรณีที่เป็นการเพิ่มมูลค่าเพื่อหลีกเลี่ยงการอธิบายสิ่งที่ชัดเจน
5. รักษาและอัปเดตความคิดเห็นหากไม่เกี่ยวข้องอีกต่อไป

นี่เป็นแนวทางทั่วไปในการมอบประสบการณ์การแสดงความคิดเห็นที่ดียิ่งขึ้น ตอนนี้เรามาดูประเด็นที่เฉพาะเจาะจงมากขึ้นสำหรับนักวิทยาศาสตร์ข้อมูลกัน

สำหรับนักวิทยาศาสตร์ข้อมูล กิจกรรมการเขียนโค้ดจะแตกต่างจากกิจกรรมของวิศวกรซอฟต์แวร์หรือนักพัฒนาเว็บ นั่นเป็นเหตุผลว่าทำไมกิจกรรมการแสดงความคิดเห็นจึงมีความแตกต่างกัน ต่อไปนี้เป็นเคล็ดลับบางประการสำหรับนักวิทยาศาสตร์ข้อมูลของเราโดยเฉพาะ

1. ใช้การแสดงความคิดเห็นเพื่อชี้แจงกระบวนการหรือกิจกรรมที่ซับซ้อน

กิจกรรมวิทยาศาสตร์ข้อมูลจะเกี่ยวข้องกับกระบวนการทดลองมากมายที่อาจสร้างความสับสนให้กับผู้อ่านหรือตัวเราในอนาคตหากเราไม่อธิบาย ความคิดเห็นในโค้ดจะช่วยให้เราอธิบายเจตนาได้ดีขึ้น โดยเฉพาะอย่างยิ่งหากมีหลายขั้นตอนที่เกี่ยวข้อง ตัวอย่างเช่น โค้ดด้านล่างนี้จะอธิบายวิธีที่เราลบค่าผิดปกติออกด้วยการทำให้เป็นมาตรฐานและปรับขนาด

# Perform data normalization (Min-Max scaling)
normalized_data = (data - np.min(data)) / (np.max(data) - np.min(data)) # Remove outliers by using the sigma rule (3 standard deviations removal)
removed_outlier_data = normalized_data[np.abs(stats.zscore(normalized_data)) 3]

ความคิดเห็นข้างต้นอธิบายถึงสิ่งที่ทำในแต่ละกระบวนการและแนวคิดเบื้องหลัง การระบุแนวคิดที่เราใช้ในโค้ดถือเป็นสิ่งสำคัญในการทำความเข้าใจสิ่งที่เราได้ทำไป

ไม่จำกัดเพียงการประมวลผลล่วงหน้า แต่สามารถแสดงความคิดเห็นได้ในขั้นตอนวิทยาศาสตร์ข้อมูลใดๆ ตั้งแต่การดึงข้อมูลไปจนถึงการตรวจสอบโมเดล การแสดงความคิดเห็นในสิ่งที่ใครๆ ก็เข้าใจถือเป็นแนวปฏิบัติที่ดี โปรดจำไว้ว่าในฐานะนักวิทยาศาสตร์ข้อมูล ความคิดเห็นของเราอาจกลายเป็นสะพานเชื่อมระหว่างโค้ดและข้อมูลเชิงลึกเชิงวิเคราะห์

2. มีมาตรฐานการแสดงความคิดเห็น

กิจกรรมวิทยาศาสตร์ข้อมูลเป็นกระบวนการทำงานร่วมกัน ดังนั้น การมีโครงสร้างมาตรฐานที่ทุกคนเข้าใจจึงเป็นเรื่องดี นอกจากนี้ยังมีประโยชน์แม้ว่าคุณจะทำงานคนเดียว เนื่องจากคุณมีมาตรฐานที่คุณจะรู้ ตัวอย่างเช่น คุณสามารถกำหนดความคิดเห็นให้เป็นมาตรฐานสำหรับทุกฟังก์ชันที่คุณทำ

# Function: name of the function
# Usage: description of how to use the function
# Parameters: list the parameters and explain them
# Output: explain the output

ข้างต้นเป็นตัวอย่างมาตรฐาน เนื่องจากคุณสามารถสร้างบางสิ่งได้อย่างอิสระ อย่าลืมใช้รูปแบบ ภาษา และคำย่อเดียวกันเมื่อคุณมีมาตรฐานเช่นนี้

3. ใช้ความคิดเห็นเพื่อช่วยในกระบวนการทำงาน

ในสภาพแวดล้อมการทำงานร่วมกัน การแสดงความคิดเห็นเป็นสิ่งสำคัญที่จะช่วยให้ทีมเข้าใจขั้นตอนการทำงาน เราสามารถใช้ความคิดเห็นเพื่อช่วยให้เข้าใจว่าเมื่อมีการอัพเดตโค้ดใหม่หรือต้องทำอะไรต่อไป ตัวอย่างเช่น การอัปเดตในฟังก์ชันอื่นทำให้เกิดข้อบกพร่องในกระบวนการของเรา ดังนั้นเราจึงจำเป็นต้องแก้ไขข้อบกพร่องต่อไป

# TODO: Fix this function ASAP
some_function_to_fix()

4. ใช้เซลล์สมุดบันทึก Markdown

Data Scientist IDE ค่อนข้างโดดเด่นเนื่องจากเราใช้ Notebook ในการทดลอง การใช้เซลล์ในโน้ตบุ๊กทำให้เราสามารถแยกแต่ละโค้ดเพื่อให้สามารถรันได้อย่างอิสระโดยไม่จำเป็นต้องรันโค้ดทั้งหมด เซลล์สมุดบันทึกไม่ได้จำกัดอยู่เพียงโค้ด แต่สามารถแปลงเป็นเซลล์ Markdown ได้ 

Markdown เป็นภาษาการจัดรูปแบบที่อธิบายว่าข้อความควรมีลักษณะอย่างไร ในเซลล์ markdown สามารถอธิบายโค้ดด้านล่างเพิ่มเติมได้ ข้อดีของการใช้ Markdown คือเราสามารถแสดงความคิดเห็นได้ละเอียดกว่ากระบวนการแสดงความคิดเห็นมาตรฐาน คุณสามารถเพิ่มตาราง รูปภาพ LaTeX และอื่นๆ อีกมากมายได้

ตัวอย่างเช่น รูปภาพด้านล่างแสดงวิธีที่เราใช้ Markdown เพื่ออธิบายโครงการ เป้าหมาย และขั้นตอนต่างๆ ของเรา 

คุณสามารถอ่านเพิ่มเติมเกี่ยวกับ Jupyter Markdown Cell ได้ใน เอกสาร เพื่อทำความเข้าใจเพิ่มเติมว่าคุณสามารถทำอะไรได้บ้าง

การแสดงความคิดเห็นเป็นส่วนสำคัญของกิจกรรมนักวิทยาศาสตร์ข้อมูล เนื่องจากช่วยให้ผู้อ่านชี้แจงสิ่งที่เกิดขึ้นกับโค้ดได้ สำหรับนักวิทยาศาสตร์ข้อมูล กระบวนการแสดงความคิดเห็นจะแตกต่างจากวิศวกรซอฟต์แวร์หรือนักพัฒนาเว็บเล็กน้อย เนื่องจากกระบวนการทำงานของเราแตกต่างกัน ด้วยเหตุนี้บทความนี้จึงให้คำแนะนำบางประการที่คุณสามารถใช้เพื่อแสดงความคิดเห็นในฐานะนักวิทยาศาสตร์ข้อมูลได้ เคล็ดลับคือ:

1. ใช้การแสดงความคิดเห็นเพื่อชี้แจงกระบวนการหรือกิจกรรมที่ซับซ้อน
2. มีมาตรฐานการแสดงความคิดเห็น
3. ใช้ความคิดเห็นเพื่อช่วยเวิร์กโฟลว์
4. ใช้เซลล์สมุดบันทึก Markdown

ผมหวังว่ามันจะช่วยให้
 
 

คอร์เนลเลียส ยุธา วิชายา เป็นผู้ช่วยผู้จัดการด้านวิทยาศาสตร์ข้อมูลและผู้เขียนข้อมูล ในขณะที่ทำงานเต็มเวลาที่ Allianz Indonesia เขาชอบแบ่งปันเคล็ดลับ Python และ Data ผ่านโซเชียลมีเดียและสื่อการเขียน

• เนื้อหาที่ขับเคลื่อนด้วย SEO และการเผยแพร่ประชาสัมพันธ์ รับการขยายวันนี้
• PlatoData.Network Vertical Generative Ai เพิ่มพลังให้กับตัวเอง เข้าถึงได้ที่นี่.
• เพลโตไอสตรีม. Web3 อัจฉริยะ ขยายความรู้ เข้าถึงได้ที่นี่.
• เพลโตESG. คาร์บอน, คลีนเทค, พลังงาน, สิ่งแวดล้อม แสงอาทิตย์, การจัดการของเสีย. เข้าถึงได้ที่นี่.
• เพลโตสุขภาพ เทคโนโลยีชีวภาพและข่าวกรองการทดลองทางคลินิก เข้าถึงได้ที่นี่.
• ที่มา: https://www.kdnuggets.com/how-to-comment-your-python-code-as-a-data-scientist?utm_source=rss&utm_medium=rss&utm_campaign=how-to-comment-your-python-code-as-a-data-scientist