kornia / kornia/tutorials

CI: Run tutorials against other kornia versions

Open
#84 0 comments 0 reactions 0 assignees View on GitHub
CI enhancement
Dominant language
Jupyter Notebook
Stars
52
Forks
36
PR merge metrics
No merged PRs in 30d

Description

With the new CI setup (#81) we can choose against which kornia version runs the tutorials. By using the git reference to the `env` action.

Example
```yaml
uses: kornia/workflows/.github/workflows/tutorials.yml@v1.4.1
with:
ref: 'main' # Or any git reference, tag, commit, etc -- so can be v0.7.0, etc
```

> This `ref` input is the git reference of kornia/kornia repository.

The problem with it now, is that not all tutorials will work on older kornia versions, so this needs to be dealt with somehow

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the CI setup from #81 and the referenced kornia/workflows/.github/workflows/tutorials.yml workflow, then inspect how the tutorials use the ref input for different Kornia versions. Define compatibility expectations for older refs and verify that the tutorials run successfully against each supported version.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, jupyter-notebook
Domain
ci-cd, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.