diff --git a/README.md b/README.md index 4bc07c2..6e53fbd 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -# MYIA -_my image AI_ +

MYIA

+this is a nocode platform for training, testing, evaluating, and building image classifier models + + + +

Table of Contents

+ +- [Features](#features) +- [Installation](#installation) +- [Usage](#usage) +- [Screenshots](#screenshots) +- [Contributing](#contributing) +- [License](#license) -this is a nocode platform for training, testing, evaluating, and building image classifier models ## Features @@ -19,6 +29,7 @@ this is a nocode platform for training, testing, evaluating, and building image +--- ## Installation @@ -56,6 +67,8 @@ this is a nocode platform for training, testing, evaluating, and building image ``` > open your browser and go to http://localhost:5000 + +--- ## Usage 1. Upload images to the app @@ -107,12 +120,32 @@ this is a nocode platform for training, testing, evaluating, and building image - The evaluation results will be saved in the `model` directory as a `json` file and a graph will be generated and saved in the `static` directory as a `png` file +--- ## Screenshots +| Image | Description | +| ----------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| A screenshot of the Home page | A screenshot of the Home page | +| A screenshot of the Training page | A screenshot of the Training page | +| A screenshot of the Testing page | A screenshot of the Testing page | +| A screenshot of the Evaluation page | A screenshot of the Evaluation page | +| A screenshot of a directory | A screenshot of a directory | +| A screenshot of a directory | A screenshot of a directory | +| A screenshot of the page for building a model | A screenshot of the page for building a model | + + +--- + +## Contributing +Feel free to ping me a pull requests if you want to contribute. + ## License -This project is licensed under the [MIT License](LICENSE). \ No newline at end of file +This project is licensed under the [MIT License](LICENSE). + + +happy coding 💜 \ No newline at end of file