README: Update, better usage, relative links #114
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In README.md:
should be mostly stable now
various supported attribution methods for VGG16 and ResNet50 produced
by feed_forward.py
about building
respective revision. They were previously absolute links for display
on PyPI, which cannot correctly disply relative files.
New images:
In setup.py
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.
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.