XAITK JATIC 集成

描述

“存储桶”，用于存放与 xaitk-saliency 集成和扩展相关的各种示例和资源，作为JATIC计划的一部分用于JATIC。

安装

以下步骤假定源树已本地获取。

使用pip安装当前版本

pip install .

或者，也可以使用Poetry

poetry install --sync --with dev-linting,dev-testing,dev-docs

用法

我们在./examples/目录中提供了一些基于Jupyter笔记本的示例，以展示如何使用xaitk-saliency包与ML生态系统中其他工具的用法。同样，与每个增量相关的演示笔记本可以在./demos/中找到。

关于将xaitk-saliency与这些工具集成的反思可以在./docs/platform_reflections/中找到。

文档

发布版本的文档快照以及最新的master版本都托管在ReadTheDocs上。

基于sphinx的文档也可以在本地构建，以获取最新的参考信息

# Install dependencies
poetry install --sync --with dev-linting,dev-testing,dev-docs
# Navigate to the documentation root.
cd docs
# Build the docs.
poetry run make html
# Open in your favorite browser!
firefox _build/html/index.html

开发工具

pre-commit hooks
pre-commit hooks用于确保任何代码都符合所有必需的linting和格式化指南。
安装后，它将在提交之前始终运行，以确保所有提交都符合标准，但您也可以在不提交的情况下手动运行检查。如果您想在存在错误的情况下提交，可以将--no-verify添加到您的提交命令中。
安装pre-commit hooks

# Ensure that all dependencies are installed  
poetry install --sync --with dev-linting,dev-testing,dev-docs  
# Initialize pre-commit for the repository  
poetry run pre-commit install  
# Run pre-commit check on all files  
poetry run pre-commit run --all-files  

贡献

• 我们遵循在JATIC 软件开发计划中概述的通用指南。
• 使用Git Flow分支策略。
• 有关详细发布信息，请参阅docs/releasing/release_process.rst。
• 有关额外贡献信息，请参阅CONTRIBUTING.md。

许可证

Apache 2.0

POC: Brian Hu @brian.hu DPOC: Paul Tunison @paul.tunison