Optim-wip: Improve docs for Sphinx

.conda/meta.yaml

@@ -13,20 +13,29 @@ build:
 
 requirements:
   host:
-    - python>=3.6
+    - python>=3.9
+    - setuptools
   run:
-    - numpy
-    - pytorch>=1.6
+    - numpy<2.0
+    - pytorch>=1.10
     - matplotlib-base
+    - tqdm
+    - packaging
 
 test:
   imports:
     - captum
 
 about:
   home: https://captum.ai
-  license: BSD
+  license: BSD-3
   license_file: LICENSE
   summary: Model interpretability for PyTorch
+  description: |
+    Captum is a model interpretability and understanding library for PyTorch.
+    Captum means comprehension in Latin and contains general purpose implementations
+    of integrated gradients, saliency maps, smoothgrad, vargrad and others for
+    PyTorch models. It has quick integration for models built with domain-specific
+    libraries such as torchvision, torchtext, and others.
   doc_url: https://captum.ai
   dev_url: https://github.com/pytorch/captum

.github/workflows/lint.yml

@@ -0,0 +1,23 @@
+name: Captum Lint
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+  workflow_dispatch:
+
+jobs:
+  tests:
+    uses: pytorch/test-infra/.github/workflows/linux_job.yml@main
+    with:
+      runner: linux.12xlarge
+      docker-image: cimg/python:3.11
+      repository: pytorch/captum
+      script: |
+        sudo chmod -R 777 .
+        ./scripts/install_via_pip.sh
+        ufmt check .
+        flake8
+        sphinx-build -WT --keep-going sphinx/source sphinx/build

.github/workflows/retry.yml

@@ -0,0 +1,26 @@
+name: Rerun tests if failed
+on:
+  workflow_run:
+    workflows: ["Unit-tests for Conda install", "Unit-tests for Pip install with mypy type checks", "Unit-tests for Pip install"]
+    types: ["completed"]
+
+permissions:
+  actions: write
+
+jobs:
+  rerun-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Log workflow metadata
+        run: |
+          echo "ID: ${{ github.event.workflow_run.id }}"
+          echo "attempt: ${{ github.event.workflow_run.run_attempt }}"
+          echo "event: ${{ github.event.workflow_run.conclusion }}"
+          echo "event: ${{ github.event.workflow_run.event }}"
+      - name: Rerun Failed Workflows
+        if: github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.run_attempt <= 3
+        env:
+          GH_TOKEN: ${{ github.token }}
+          RUN_ID: ${{ github.event.workflow_run.id }}
+        run: |
+          gh run rerun ${RUN_ID} --repo="${{ github.repository }}" --failed

.github/workflows/test-conda-cpu.yml

@@ -0,0 +1,34 @@
+name: Unit-tests for Conda install
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+  workflow_dispatch:
+
+env:
+  CHANNEL: "nightly"
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        python_version: ["3.9", "3.10", "3.11", "3.12"]
+      fail-fast: false
+    uses: pytorch/test-infra/.github/workflows/linux_job.yml@main
+    with:
+      runner: linux.12xlarge
+      repository: pytorch/captum
+      script: |
+        # Set up Environment Variables
+        export PYTHON_VERSION="${{ matrix.python_version }}"
+
+        # Create Conda Env
+        conda create -yp ci_env python="${PYTHON_VERSION}"
+        conda activate /pytorch/captum/ci_env
+        ./scripts/install_via_conda.sh
+
+        # Run Tests
+        python3 -m pytest -ra --cov=. --cov-report term-missing