這是一個創建給定Python函數的文檔字符串的示例。我們指定Python版本,粘貼代碼,然後在注釋中要求編寫文檔字符串,并給出文檔字符串的特征開頭(""")。
提示:
# Python 3.7
def randomly_split_dataset(folder, filename, split_ratio=[0.8, 0.2]):
df = pd.read_json(folder + filename, lines=True)
train_name, test_name = "train.jsonl", "test.jsonl"
df_train, df_test = train_test_split(df, test_size=split_ratio[1], random_state=42)
df_train.to_json(folder + train_name, orient='records', lines=True)
df_test.to_json(folder + test_name, orient='records', lines=True)
randomly_split_dataset('finetune_data/', 'dataset.jsonl')# 上述函數的詳細高質量文檔字符串:
"""
樣本回複:
"""此函數根據給定的分割比例,随機将數據集分成兩部分:訓練集和測試集。
參數:
folder(str):包含數據集的文件夾路徑。
filename(str):數據集文件的名稱。
split_ratio(list):包含兩個浮點數的列表,表示訓練集和測試集的比例。返回值:
None
"""
评论1
可以為舊程序編寫注釋
從例子來看,像是對一個以前定義的函數補充開頭缺失的注釋,我覺得這對于把老的、缺少注釋的程序進行整理很有用,節約了人工閱讀、理解老代碼的時間。我自己以前寫程序就缺少規範,定義的函數沒有寫明輸入、輸出的參數說明,看這個例子就能很好進行補充。👍