From f2fbb84023aac8936b24689c26563dbb22193084 Mon Sep 17 00:00:00 2001 From: Adrian Hill Date: Mon, 1 Aug 2022 18:00:28 +0200 Subject: [PATCH] Fixes to README and release instructions --- README.md | 3 +-- todo_before_release.md | 10 ++++++---- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9c722017..0dd8c2a1 100644 --- a/README.md +++ b/README.md @@ -134,12 +134,11 @@ import tensorflow.keras.applications.vgg16 as vgg16 tf.compat.v1.disable_eager_execution() import innvestigate -import innvestigate.utils # Get model model, preprocess = vgg16.VGG16(), vgg16.preprocess_input # Strip softmax layer -model = innvestigate.utils.model_wo_softmax(model) +model = innvestigate.model_wo_softmax(model) # Create analyzer analyzer = innvestigate.create_analyzer("deep_taylor", model) diff --git a/todo_before_release.md b/todo_before_release.md index 9feee667..9ebddaef 100644 --- a/todo_before_release.md +++ b/todo_before_release.md @@ -9,16 +9,18 @@ poetry run sphinx-build docs/source docs/_build ``` - Update release in `VERSION.md`, `setup.py` and button of `README.md`. -- Make release -- Push master and develop branch, and tags -- Switch to master branch - Upload new packages to test server: ```bash poetry build poetry config repositories.testpypi https://test.pypi.org/legacy/ poetry publish -r testpypi ``` -- Check that everything works +- Check that the installation from the test server works, e.g. via + ```bash + pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple innvestigate + ``` +- Tag commit according to [Semantic Versioning](https://semver.org) guidelines, e.g. `2.0.0` +- Go to releases tab on GitHub and "Create a new release" - Upload new packages to real server: ```bash poetry publish