This is the first release of AIMANE
This release can
- Install env and lib automatically
- Prepare the MNIST dataset
- Use the MNIST dataset that prepared to train the model
- Use the model to predict what users have written
- If the model predicted wrong, the User can correct the model's mistake
- Use the user-corrected data to train the model in the next train
This release is designed for Windows with Python 3.10 or 3.11 and can run by using run_aimane.bat
If you are using another operating system, such as macOS or Linux, you can manually install it by following these steps:
0. (Alternative) If you want to clone the repo instead of downloading the release you can use:
git clone https://github.com/Nicezki/aimane.git
1. Creating virtual environment to use:
python3 -m venv venv
2. Activate the virtual environment:
source venv/bin/activate
3. Install Required Libraries
For python 3.10 use:
pip install -r requirements.txt
For Python 3.11 use:
pip install -r requirements_3_11.txt
4. Run AIMANE:
Running the server:
waitress-serve --listen=*:5000 server:server_app
Running the client:
waitress-serve --listen=*:8080 client:client_app
Note: Please activate the virtual environment before running the commands using the source venv/bin/activate command.
Additional Notes
Access the AIMANE server at http://localhost:5000/app/v1/ and the client at http://localhost:8080/.
The AIMANE server and client should not be closed as it will stop the programs from running.
Stopping AIMANE
To stop the AIMANE server and client, you can use the following command:
pkill -f waitress-serve
For Downloading:
This release comes with 2 files
You need to CHOOSE ONE of the files only
aimane-v1-prepared.zip
Download this if you want full AIMANE with the prepared dataset and some of pre-user-corrected data to use and a pre-trained model
aimane-v1.zip
Download this if you want a fresh install without anything, You need to use Prepare the dataset feature yourself
Full Changelog: https://github.com/Nicezki/aimane/commits/v1.0.0