aisrv 0.1.dev0

Description:

aisrv 0.1.dev0

Copyright (c) 2023 Jérémie DECOCK (www.jdhp.org)

Web site: http://www.jdhp.org/software_en.html#aiapi
Online documentation: https://jdhp-dev.gitlab.io/aiapi
Examples: https://jdhp-dev.gitlab.io/aiapi/gallery/
Notebooks: https://gitlab.com/jdhp-dev/ai-api-notebooks
Source code: https://gitlab.com/jdhp-dev/ai-api
Issue tracker: https://gitlab.com/jdhp-dev/ai-api/issues
Pytest code coverage: https://jdhp-dev.gitlab.io/aiapi/htmlcov/index.html
AI-API on PyPI: https://pypi.org/project/aiapi


Description
AI API
Note:

This project is still in beta stage, so the API is not finalized yet.



Dependencies
C.f. requirements.txt


Installation (development environment)

Posix (Linux, MacOSX, WSL, …)
From the AI-API source code:
conda deactivate # Only if you use Anaconda...
python3 -m venv env
source env/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements-dev.txt


Windows
From the AI-API source code:
conda deactivate # Only if you use Anaconda...
python3 -m venv env
env\Scripts\activate.bat
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements-dev.txt



Installation (production environment)
python3 -m pip install --no-cache-dir "aiapi @ git+ssh://git@gitlab.com/jdhp-dev/ai-api.git"


Documentation

Online documentation: https://jdhp-dev.gitlab.io/aiapi
API documentation: https://jdhp-dev.gitlab.io/aiapi/api.html



Example usage

Examples: https://jdhp-dev.gitlab.io/aiapi/gallery/



Build and run the Python Docker image

Build the docker image
From the AI-API source code:
docker build -t aiapi:latest .


Run unit tests from the docker container
From the AI-API source code:
docker run aiapi pytest


Run an example from the docker container
From the AI-API source code:
docker run aiapi python3 /app/examples/hello.py



Bug reports
To search for bugs or report them, please use the AI-API Bug Tracker at:

https://gitlab.com/jdhp-dev/ai-api/issues



License
This project is provided under the terms and conditions of the MIT License.