帮助与故障排除
故障排除
要开始故障排除,我们需要将问题追溯到代码中的错误或其他原因(例如您的本地环境)。第一步是创建一个全新的环境并重新安装(有关说明,请参阅安装指南)。在许多情况下,此步骤将解决问题。
如果问题可以在新环境中重现,则很可能是软件错误。在继续之前,请查看 common_issues
以检查它是否是先前已识别的常见问题。
报告错误
为确保该错误尚未报告,请在 Github 问题 下搜索。如果您找不到解决该问题的开放问题,请创建新问题。如果可能,请使用相关的错误报告模板创建问题。
您应该提供重现此错误所需的最少信息。本指南可以帮助编写最小错误报告。请包含:
-
您用于生成报告的最少代码
-
版本信息对于重现和解决错误至关重要。请包含相关的环境详情,例如:
- 操作系统(例如 Windows, Linux, Mac)
- Python 版本(例如
3.7
) - 界面:Jupyter notebook(或 Google Colab、Kaggle Kernels 等云服务)、控制台或 IDE(如 PyCharm、VS Code 等)
- 包管理器(例如
pip --version
或conda info
) - 包(
pip freeze > packages.txt
或conda list
)。请确保这些信息包含在可折叠部分中(说明如下)
-
数据集样本(
df.sample()
或df.head()
)。如果数据集是机密的,例如包含公司敏感信息,请提供产生相同错误的合成或开放数据集。如有必要,您可以匿名化列名。 -
数据集及其结构的描述,例如通过报告
df.info()
的输出中的 DataFrame 结构。
问题格式
为了编写有帮助且易于阅读的问题,建议使用两种格式技巧:
- 代码高亮:将所有代码和错误消息包装在栅栏块中,特别是添加语言标识符。有关详细信息,请查阅 Github 关于高亮代码块的文档。
- 可折叠部分:将长错误消息和需求列表组织在可折叠部分中。Github 关于可折叠部分的文档提供了详细信息。
使用 Stack Overflow
需要关于如何使用 ydata-profiling
帮助的用户应该考虑在 Stack Overflow 上提问,使用专门的 ydata-profiling
标签:
用于询问有关 ydata-profiling
旧版本的问题。
Discord 社区
加入 Discord 社区,与其他用户和开发者联系,他们可能能够回答您的问题。建议在 #ydata-profiling 和 #need-help 频道提出问题。