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

Improve layout

Browse source
This commit is contained in:
Andras Schmelczer 2022-07-15 17:07:41 +02:00
parent 4debf1cf93
commit aa548f0074
No known key found for this signature in database
GPG key ID: 39260B5B0614A13E
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -39,7 +39,7 @@ That's it. Your GreatAI service is _nearly_ ready for production use. Many of th
![scope of GreatAI](https://raw.githubusercontent.com/schmelczer/great-ai/main/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: GreatAI fits between the prototype and deployment phases of your AI development lifecycle. This is highlighted with blue in the diagram. Here, several best practices can be automatically implemented aiming to achieve the following attributes:
- **G**eneral: use any Python library without restriction - **G**eneral: use any Python library without restriction
- **R**obust: have error-handling and well-tested utilities out-of-the-box - **R**obust: have error-handling and well-tested utilities out-of-the-box
@ -82,14 +82,22 @@ pip install --upgrade flit pip
flit install --symlink flit install --symlink
``` ```
### Run tests ### Develop
```sh
scripts/format-python.sh great_ai docs tests
```
> Format code.
```sh ```sh
python3 -m pytest --doctest-modules --asyncio-mode=strict . python3 -m pytest --doctest-modules --asyncio-mode=strict .
``` ```
### Serve documentation > Run tests.
```sh ```sh
mkdocs serve mkdocs serve
``` ```
> Serve documentation.