iNNvestigate 项目教程

1. 项目目录结构及介绍

iNNvestigate 项目的目录结构如下：

innvestigate/
├── docs/
├── examples/
├── src/
│   └── innvestigate/
├── tests/
├── git-blame-ignore-revs
├── gitconfig
├── gitignore
├── pre-commit-config.yaml
├── LICENSE
├── README.md
├── VERSION.md
├── pyproject.toml
├── todo_before_release.md
└── tox.ini

目录介绍

• docs/: 包含项目的文档文件。
• examples/: 包含项目的示例代码，包括 Python 脚本和 Jupyter Notebook。
• src/innvestigate/: 包含 iNNvestigate 库的核心代码。
• tests/: 包含项目的测试代码。
• git-blame-ignore-revs: Git 配置文件，用于忽略某些提交的 blame 信息。
• gitconfig: Git 配置文件。
• gitignore: Git 忽略文件配置。
• pre-commit-config.yaml: 预提交钩子配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• VERSION.md: 项目版本信息。
• pyproject.toml: 项目构建和依赖管理配置文件。
• todo_before_release.md: 发布前的待办事项列表。
• tox.ini: 用于自动化测试的配置文件。

2. 项目启动文件介绍

iNNvestigate 项目没有明确的“启动文件”，因为它是一个库，而不是一个独立的应用程序。用户通常会通过导入 innvestigate 模块来使用该库。以下是一个简单的示例，展示了如何导入和使用 iNNvestigate：

import tensorflow as tf
import innvestigate

# 禁用 TensorFlow 2 的 eager execution
tf.compat.v1.disable_eager_execution()

# 创建一个 Keras 模型
model = create_keras_model()

# 创建一个分析器
analyzer = innvestigate.create_analyzer("gradient", model)

# 分析输入对输出神经元的影响
analysis = analyzer.analyze(inputs)

3. 项目的配置文件介绍

iNNvestigate 项目中有几个重要的配置文件：

pyproject.toml

pyproject.toml 文件用于配置项目的构建系统和依赖管理。以下是一个示例：

[tool.poetry]
name = "innvestigate"
version = "1.0.0"
description = "A toolbox to iNNvestigate neural networks' predictions"
authors = ["Maximilian Alber <[e-mail]>"]

[tool.poetry.dependencies]
python = "^3.6"
tensorflow = "^2.0"
keras = "^2.3"
matplotlib = "^3.1"

[tool.poetry.dev-dependencies]
pytest = "^5.2"

tox.ini

tox.ini 文件用于配置自动化测试环境。以下是一个示例：

[tox]
envlist = py36, py37, py38

[testenv]
deps =
    pytest
commands =
    pytest tests/

pre-commit-config.yaml

pre-commit-config.yaml 文件用于配置预提交钩子，确保代码在提交前符合一定的质量标准。以下是一个示例：

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.3.0
    hooks:
      - id: check-yaml
      - id: end-of-file-fixer
      - id: trailing-whitespace

通过这些配置文件，开发者可以确保项目的依赖管理、测试环境和代码质量得到有效控制。