Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: Update, better usage, relative links #114

Merged
merged 1 commit into from
Mar 31, 2022

Conversation

chr5tphr
Copy link
Owner

@chr5tphr chr5tphr commented Mar 31, 2022

In README.md:

  • bring the Usage part up-to-date, with some better formatting
  • add a small demonstration in Usage
  • move Documentation to its own Section, so it can be found more easily
  • remove statement about "interfaces can break anytime", the interface
    should be mostly stable now
  • add another link to the documentation after Usage
  • give more details in the introduction to the Example
  • add a section Example Heatmaps, which shows example heatmaps for
    various supported attribution methods for VGG16 and ResNet50 produced
    by feed_forward.py
  • add a sub-section about the documentation in Contributing with notes
    about building
  • make absolute github links relative, such that they can point to their
    respective revision. They were previously absolute links for display
    on PyPI, which cannot correctly disply relative files.
  • add badge for tests
  • fix inconsistent capitalizations
  • fix Pytest link pointing to Pylint

New images:

  • add two images to show heatmaps for VGG16 and ResNet50

In setup.py

  • define a function to fetch the long description for PyPI, which
    replaces relative links with absolute ones on github. This fixes the
    previous problem with relative links on PyPI, and will also display
    and reference files for the correct release, instead of always for
    master.
  • due to python -m build by default copying all files for the sdist,
    and then building the wheel in the same folder in an isolated
    environment, the revison would not be correct within the wheel. The
    sdist however creates a PKG-INFO file, which will contain the
    long_description with the absolute links, which will be used if the
    git version cannot be used. The fallback is to use master, as done
    previously.

In README.md:
- bring the Usage part up-to-date, with some better formatting
- add a small demonstration in Usage
- move Documentation to its own Section, so it can be found more easily
- remove statement about "interfaces can break anytime", the interface
  should be mostly stable now
- add another link to the documentation after Usage
- give more details in the introduction to the Example
- add a section Example Heatmaps, which shows example heatmaps for
  various supported attribution methods for VGG16 and ResNet50 produced
  by feed_forward.py
- add a sub-section about the documentation in Contributing with notes
  about building
- make absolute github links relative, such that they can point to their
  respective revision. They were previously absolute links for display
  on PyPI, which cannot correctly disply relative files.
- add badge for tests
- fix inconsistent capitalizations
- fix Pytest link pointing to Pylint

New images:
- add two images to show heatmaps for VGG16 and ResNet50

In setup.py
- define a function to fetch the long description for PyPI, which
  replaces relative links with absolute ones on github. This fixes the
  previous problem with relative links on PyPI, and will also display
  and reference files for the correct release, instead of always for
  master.
- due to `python -m build` by default copying all files for the sdist,
  and then building the wheel in the same folder in an isolated
  environment, the revison would not be correct within the wheel. The
  sdist however creates a PKG-INFO file, which will contain the
  long_description with the absolute links, which will be used if the
  git version cannot be used. The fallback is to use master, as done
  previously.
@chr5tphr chr5tphr merged commit a5a622d into master Mar 31, 2022
@chr5tphr chr5tphr deleted the readme-update-local-img branch March 31, 2022 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant