帮助与故障排除
故障排除
要开始故障排除,我们需要将问题追溯到代码中的错误或其他因素(例如您的本地环境)。第一步是使用全新安装创建一个新环境(有关说明,请参阅安装指南)。在许多情况下,通过此步骤可以解决问题。
如果在新环境中可以重现问题,那么它很可能是软件错误。在继续之前,请检查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()
)。如果数据集是机密的,例如包含公司敏感信息,请提供一个合成或公开的数据集,该数据集会产生相同的错误。如果需要,您可以匿名列名。 -
数据集及其结构的描述,例如通过报告DataFrame的结构,使用
df.info()
的输出。
问题格式化
为了编写有帮助且易于阅读的问题,建议使用两种格式化技巧:
- 代码高亮:将所有代码和错误消息包装在围栏块中,特别是添加语言标识符。有关详细信息,请查看Github关于高亮代码块的文档。
- 折叠部分:将长错误消息和需求列表组织在折叠部分中。Github关于折叠部分的文档提供了详细信息。
使用Stack Overflow
对于如何使用ydata-profiling
寻求帮助的用户,应考虑在Stack Overflow上提出他们的问题,使用专门的ydata-profiling
标签:
对于ydata-profiling
旧版本的问题。
Discord社区
加入Discord社区,与可能能够回答您问题的其他用户和开发者联系。建议在#ydata-profiling和#need-help频道提问和讨论问题。