Update readme

Author: BirkhoffG

README.md

@@ -1,23 +1,25 @@
-jax-interpret
-================
+# Explainax: An Explainable AI Library for JAX
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
-This file will become your README and also the index of your
-documentation.
+![Python](https://img.shields.io/pypi/pyversions/explainax.svg) ![CI
+status](https://github.com/BirkhoffG/explainax/actions/workflows/test.yaml/badge.svg)
+![Docs](https://github.com/BirkhoffG/explainax/actions/workflows/deploy.yaml/badge.svg)
+![pypi](https://img.shields.io/pypi/v/explainax.svg) ![GitHub
+License](https://img.shields.io/github/license/BirkhoffG/explainax.svg)
 
-## Install
+`explainax` is a JAX library for model explanation and interpretation.
+
+## Quick install
+
+Simply install via `pypi`:
 
 ``` sh
-pip install jax_interpret
+pip install explainax --upgrade
 ```
 
-## How to use
-
-Fill me in please! Don’t forget code examples:
+Or upgrade to the latest version of `explainax`:
 
-``` python
-1+1
+``` sh
+pip install git+https://github.com/BirkhoffG/explainax.git --upgrade
 ```
-
-    2

nbs/index.ipynb

@@ -9,79 +9,49 @@
     "#| hide"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# jax-interpret\n",
-    "\n",
-    "> "
-   ]
-  },
   {
    "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Interpret black-box models in jax."
+    "# Explainax: An Explainable AI Library for JAX\n"
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Install"
+    "\n",
+    "![Python](https://img.shields.io/pypi/pyversions/explainax.svg) ![CI\n",
+    "status](https://github.com/BirkhoffG/explainax/actions/workflows/test.yaml/badge.svg)\n",
+    "![Docs](https://github.com/BirkhoffG/explainax/actions/workflows/deploy.yaml/badge.svg)\n",
+    "![pypi](https://img.shields.io/pypi/v/explainax.svg) \n",
+    "![GitHub License](https://img.shields.io/github/license/BirkhoffG/explainax.svg)\n",
+    "\n",
+    "\n",
+    "`explainax` is a JAX library for model explanation and interpretation."
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "## Quick install\n",
+    "\n",
+    "Simply install via `pypi`:\n",
+    "\n",
     "```sh\n",
-    "pip install jax_interpret\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## How to use"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Fill me in please! Don't forget code examples:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "2"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "1+1"
+    "pip install explainax --upgrade\n",
+    "```\n",
+    "\n",
+    "Or upgrade to the latest version of `explainax`:\n",
+    "\n",
+    "```sh\n",
+    "pip install git+https://github.com/BirkhoffG/explainax.git --upgrade\n",
+    "```\n"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

settings.ini

@@ -3,7 +3,7 @@
 # See https://github.com/fastai/nbdev/blob/master/settings.ini for examples.
 
 ### Python library ###
-repo = jax-explainax
+repo = explainax
 lib_name = %(repo)s
 version = 0.0.1
 min_python = 3.7