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

Improve documentation

Browse source
This commit is contained in:
Andras Schmelczer 2022-07-09 23:10:21 +02:00
parent 51f6f7174b
commit 63a45989f4
No known key found for this signature in database
GPG key ID: 0EA1BC97D0AB076E
40 changed files with 956 additions and 420 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,13 +1,15 @@
# GreatAI
# ![logo](docs/media/favicon.ico) GreatAI
> GreatAI helps you easily transform your prototype AI code into production-ready software.
**work in progress, do not use!**
[![Test](https://github.com/schmelczer/great-ai/actions/workflows/test.yml/badge.svg)](https://github.com/schmelczer/great-ai/actions/workflows/check.yml)
[![Test](https://github.com/schmelczer/great-ai/actions/workflows/test.yml/badge.svg)](https://github.com/schmelczer/great-ai/actions/workflows/test.yml)
[![Quality Gate Status](https://sonar.scoutinscience.com/api/project_badges/measure?project=great-ai&metric=alert_status)](https://sonar.schmelczer.com/dashboard?id=great-ai)
[![Publish on PyPI](https://github.com/schmelczer/great-ai/actions/workflows/publish.yaml/badge.svg)](https://github.com/schmelczer/great-ai/actions/workflows/publish.yaml)
[![Publish on DockerHub](https://github.com/schmelczer/great-ai/actions/workflows/docker.yaml/badge.svg)](https://github.com/schmelczer/great-ai/actions/workflows/docker.yaml)
[![Downloads](https://pepy.tech/badge/great-ai/month)](https://pepy.tech/project/great-ai)
[Check out the documentation here](https://great-ai.scoutinscience.com/).
## Find `great-ai` on [DockerHub](https://hub.docker.com/repository/docker/schmelczera/great-ai)
@ -33,8 +35,10 @@ def hello_world(name: str) -> str:
```
> Create a new file called `main.py`
Deploy by executing `python3 -m great-ai main.py`
> Or: `python3 -m great-ai main.py`
Deploy by executing `great-ai main.py`
> Or: `great_ai main.py`
> Or: `python3 -m great_ai main.py`
Find the dashboard at [http://localhost:6060](http://localhost:6060/dashboard/).