andras/great-ai
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases 4 Packages Wiki Activity Actions

Improve readme add og-image

Browse source
This commit is contained in:
Andras Schmelczer 2022-07-12 16:02:59 +02:00
parent dc1a36edac
commit ce19e5f05a
No known key found for this signature in database
GPG key ID: 0EA1BC97D0AB076E
7 changed files with 62 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -1,15 +1,19 @@
# ![logo](docs/media/favicon.ico) GreatAI
[![Sonar line coverage](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=coverage)](https://sonar.scoutinscience.com/dashboard?id=great-ai)
[![Sonar LoC](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=ncloc)](https://sonar.scoutinscience.com/dashboard?id=great-ai)
[![Test](https://github.com/schmelczer/great-ai/actions/workflows/test.yml/badge.svg)](https://github.com/schmelczer/great-ai/actions/workflows/test.yml)
# <img src="https://github.com/schmelczer/great-ai/blob/main/docs/media/logo.png" alt="logo of great-ai" width=60 /> 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)
[![Downloads](https://pepy.tech/badge/great-ai/month)](https://pepy.tech/project/great-ai)
![Docker Pulls](https://img.shields.io/docker/pulls/schmelczera/great-ai)
[![Test](https://github.com/schmelczer/great-ai/actions/workflows/test.yml/badge.svg)](https://github.com/schmelczer/great-ai/actions/workflows/test.yml)
[![Sonar line coverage](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=coverage)](https://sonar.scoutinscience.com/dashboard?id=great-ai)
[![Sonar LoC](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=ncloc)](https://sonar.scoutinscience.com/dashboard?id=great-ai)
Applying AI is becoming increasingly easier but many case studies have shown that these applications are often deployed poorly. This may lead to suboptimal performance and to introducing unintended biases. GreatAI helps fixing this by allowing you to easily transform your prototype AI code into production-ready software.
GreatAI helps you easily transform your prototype AI code into production-ready software.
[Check out the full documentation here](https://great-ai.scoutinscience.com).
## Example
```sh
pip install great-ai
```
@ -34,7 +38,7 @@ That's it. Your GreatAI service is ready for production use. Many of the [SE4ML
![scope of GreatAI](docs/media/scope-simple.drawio.svg)
GreatAI fits between the prototype and deployment phases of your (or your organisation's) 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:
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:
- **G**eneral: use any Python library without restriction
- **R**obust: have error-handling and well-tested utilities out-of-the-box
@ -48,16 +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.
## Learn more
[Check out the documentation](https://great-ai.scoutinscience.com).
## Find `great-ai` on [DockerHub](https://hub.docker.com/repository/docker/schmelczera/great-ai)
```sh
docker run -p6060:6060 schmelczera/great-ai
```
## Learn more
[Check out the documentation](https://great-ai.scoutinscience.com).
## Contribute
Contributions are welcome.
@ -67,12 +71,18 @@ Contributions are welcome.
```sh
python3 -m venv --copies .env
source .env/bin/activate
python3 -m pip install flit
python3 -m flit install --symlink --deps=all
pip install flit
flit install --symlink --deps=all
```
### Run tests
```sh
pytest --doctest-modules --asyncio-mode=strict
```
### Serve documentation
```sh
mkdocs serve --dirtyreload
mkdocs serve
```