# G-Label
A FastAPI-based image classification application for annotation. This package allows users to set an image folder, classify images into different categories, and provides an undo feature to correct mistakes. It is designed for fast and efficient annotation workflows.
## Installation
To install the package, ensure you have Python 3.6 or later installed. You can install `glabel` from PyPi using `pip`:
```bash
pip install glabel
```
## Usage
Once installed, you can start the FastAPI application using the CLI command `glabel`:
```bash
glabel
```
This will start a FastAPI server, usually running on http://127.0.0.1:8000/. Open this URL in a web browser to access the application.
## Setting the Folder and Classes
- Open [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in a browser.
- Use the provided form to set the folder where your images are stored.
- Enter the classes/categories for classification as a comma-separated list.
## Classifying Images
After setting the image folder and classes:
1. Click the "Go to Classify" link to start the classification process.
2. You will see an image displayed in a consistent container with classification buttons below it.
3. Click the appropriate button to classify the image into that category.
4. After classification, the next image is automatically displayed for further classification.
## Undoing a Classification
If you need to undo the last classification:
- Click the "Undo Last Classification" button, which appears beside the classification buttons.
- The previously classified image will be restored to its original state, allowing you to reclassify it.
## Contributing
We welcome contributions to glabel. To contribute:
1. Fork this repository on GitHub.
2. Create a new branch for your changes.
3. Open a pull request with a description of your changes.
For more information, see the CONTRIBUTING.md file (if applicable).
## License
This project is licensed under the MIT License. You can find a copy of the license in the project repository.
## Additional Resources
- For more information on FastAPI, visit the [FastAPI documentation](https://fastapi.tiangolo.com/).
- For questions or support, you can create an issue on GitHub.
## Contact
For questions, support, or collaboration, you can reach out to [gaurang.ingle@gmail.com](mailto:gaurang.ingle@gmail.com).
Raw data
{
"_id": null,
"home_page": "https://github.com/gaurang157/glabel",
"name": "glabel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "image-classification, annotation, fastapi",
"author": "Gaurang Ingle",
"author_email": "gaurang.ingle@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5c/0d/74040fe97f14b4493cef5e38058a9bed5d76a41858a690ef655900ee37ff/glabel-1.0.3.tar.gz",
"platform": null,
"description": "# G-Label\r\n\r\nA FastAPI-based image classification application for annotation. This package allows users to set an image folder, classify images into different categories, and provides an undo feature to correct mistakes. It is designed for fast and efficient annotation workflows.\r\n\r\n## Installation\r\n\r\nTo install the package, ensure you have Python 3.6 or later installed. You can install `glabel` from PyPi using `pip`:\r\n\r\n```bash\r\npip install glabel\r\n```\r\n\r\n## Usage\r\nOnce installed, you can start the FastAPI application using the CLI command `glabel`:\r\n```bash\r\nglabel\r\n```\r\nThis will start a FastAPI server, usually running on http://127.0.0.1:8000/. Open this URL in a web browser to access the application.\r\n\r\n## Setting the Folder and Classes\r\n- Open [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in a browser.\r\n- Use the provided form to set the folder where your images are stored.\r\n- Enter the classes/categories for classification as a comma-separated list.\r\n\r\n## Classifying Images\r\nAfter setting the image folder and classes:\r\n\r\n1. Click the \"Go to Classify\" link to start the classification process.\r\n2. You will see an image displayed in a consistent container with classification buttons below it.\r\n3. Click the appropriate button to classify the image into that category.\r\n4. After classification, the next image is automatically displayed for further classification.\r\n\r\n## Undoing a Classification\r\nIf you need to undo the last classification:\r\n\r\n- Click the \"Undo Last Classification\" button, which appears beside the classification buttons.\r\n- The previously classified image will be restored to its original state, allowing you to reclassify it.\r\n\r\n## Contributing\r\nWe welcome contributions to glabel. To contribute:\r\n\r\n1. Fork this repository on GitHub.\r\n2. Create a new branch for your changes.\r\n3. Open a pull request with a description of your changes.\r\n\r\nFor more information, see the CONTRIBUTING.md file (if applicable).\r\n\r\n## License\r\nThis project is licensed under the MIT License. You can find a copy of the license in the project repository.\r\n\r\n## Additional Resources\r\n- For more information on FastAPI, visit the [FastAPI documentation](https://fastapi.tiangolo.com/).\r\n- For questions or support, you can create an issue on GitHub.\r\n\r\n## Contact\r\nFor questions, support, or collaboration, you can reach out to [gaurang.ingle@gmail.com](mailto:gaurang.ingle@gmail.com).\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "FastAPI-based image classification app for annotation",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/gaurang157/glabel"
},
"split_keywords": [
"image-classification",
" annotation",
" fastapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c0d74040fe97f14b4493cef5e38058a9bed5d76a41858a690ef655900ee37ff",
"md5": "a4c2a0460334d7deed80cecd73ee658c",
"sha256": "1a0f0ae01ff3e638168655c7a2fcf47a6592cd26e605fb0aca13a0fbf4e744c3"
},
"downloads": -1,
"filename": "glabel-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "a4c2a0460334d7deed80cecd73ee658c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5041,
"upload_time": "2024-04-26T16:27:51",
"upload_time_iso_8601": "2024-04-26T16:27:51.858235Z",
"url": "https://files.pythonhosted.org/packages/5c/0d/74040fe97f14b4493cef5e38058a9bed5d76a41858a690ef655900ee37ff/glabel-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 16:27:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gaurang157",
"github_project": "glabel",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "glabel"
}
JSON
