From 2d35bb1f70b3ca15374ca9ee7f871b7208d99baa Mon Sep 17 00:00:00 2001 From: Andras Schmelczer Date: Wed, 13 Jul 2022 20:33:26 +0200 Subject: [PATCH] Fix readme on PyPI --- README.md | 16 +++++++++++----- great_ai/__init__.py | 2 +- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8f146a9..5b556b4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# logo of great-ai GreatAI +# logo of great-ai GreatAI > Easily transform your prototype AI code into production-ready software. [![PyPI version](https://badge.fury.io/py/great-ai.svg)](https://badge.fury.io/py/great-ai) @@ -28,7 +28,7 @@ def greeter(name: str) -> str: Start it by executing `great-ai demo.py`, find the dashboard at [http://localhost:6060](http://localhost:6060/dashboard). -![demo screen capture](https://github.com/schmelczer/great-ai/blob/main/docs/media/demo.gif) +![demo screen capture](https://raw.githubusercontent.com/schmelczer/great-ai/main/docs/media/demo.gif) That's it. Your GreatAI service is *nearly* ready for production use. Many of the [SE4ML best-practices](https://se-ml.github.io) are configured and implemented automatically (of course, these can be customised as well). @@ -36,7 +36,7 @@ That's it. Your GreatAI service is *nearly* ready for production use. Many of th ## Why is this GREAT? -![scope of GreatAI](docs/media/scope-simple.drawio.svg) +![scope of GreatAI](https://raw.githubusercontent.com/schmelczer/great-ai/main/docs/media/scope-simple.drawio.svg) GreatAI fits between the prototype and deployment phases of your AI development lifecycle. This is highlighted with blue in the diagram. Here, a number of best practices can be automatically implemented aiming to achieve the following attributes: @@ -52,10 +52,16 @@ There are other, existing solutions aiming to facilitate this phase. [Amazon Sag However, [research indicates](https://great-ai.scoutinscience.com) that professionals rarely use them. This may be due to their inherent setup and operating complexity. **GreatAI is designed to be as simple to use as possible.** Its clear, high-level API and sensible default configuration makes it extremely easy to start using. Despite its relative simplicity over Seldon Core, it still implements many of the [SE4ML best-practices](https://se-ml.github.io), and thus, can meaningfully improve your deployment without requiring prohibitively large effort. -## Find `great-ai` on [PyPI](https://hub.docker.com/repository/docker/schmelczera/great-ai) - ## [Learn more](https://great-ai.scoutinscience.com) +[Check out the full documentation here](https://great-ai.scoutinscience.com). + +## Find `great-ai` on [PyPI](https://pypi.org/project/great-ai/) + +```sh +pip install great-ai +``` + ## Find `great-ai` on [DockerHub](https://hub.docker.com/repository/docker/schmelczera/great-ai) ```sh diff --git a/great_ai/__init__.py b/great_ai/__init__.py index a80ed2d..3dca0bc 100644 --- a/great_ai/__init__.py +++ b/great_ai/__init__.py @@ -1,5 +1,5 @@ """GreatAI.""" -__version__ = "0.1.5" +__version__ = "0.1.6" from .context import configure