这是一个创建给定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
可以为旧程序编写注释
从例子来看,像是对一个以前定义的函数补充开头缺失的注释,我觉得这对于把老的、缺少注释的程序进行整理很有用,节约了人工阅读、理解老代码的时间。我自己以前写程序就缺少规范,定义的函数没有写明输入、输出的参数说明,看这个例子就能很好进行补充。👍