https://github.com/zhiwei2017/nazi-symbols-classification
Source code for my master thesis nazi symbols classification
https://github.com/zhiwei2017/nazi-symbols-classification
Last synced: about 2 months ago
JSON representation
Source code for my master thesis nazi symbols classification
- Host: GitHub
- URL: https://github.com/zhiwei2017/nazi-symbols-classification
- Owner: zhiwei2017
- License: mit
- Created: 2024-10-08T20:32:01.000Z (7 months ago)
- Default Branch: develop
- Last Pushed: 2025-03-03T21:36:11.000Z (2 months ago)
- Last Synced: 2025-03-03T22:28:15.600Z (2 months ago)
- Language: Jupyter Notebook
- Size: 7.78 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
nazi-symbols-classification
===========================
Introduction
------------
Nazi symbols classification source code.
User Guide
----------
How to Install
++++++++++++++
Stable release
``````````````
To install nazi-symbols-classification, run this command in your terminal:
.. code-block:: console
$ pip install nazi_symbols_classification
or
.. code-block:: console
$ poetry self add nazi_symbols_classification
This is the preferred method to install nazi-symbols-classification, as it will always install the most recent stable release.
From sources
````````````
The sources for nazi-symbols-classification can be downloaded from the `Github repo `_.
You can either clone the public repository:
.. code-block:: console
$ git clone https://github.com/zhiwei2017/nazi-symbols-classification.git
Once you have a copy of the source, you can install it with:
.. code-block:: console
$ pip install .
or
.. code-block:: console
$ poetry install
How to Use
++++++++++
nazi-symbols-classification
---------------------------
To use nazi-symbols-classification in a project::
import nazi_symbols_classification
nazi_symbols_classification_backend
-----------------------------------
To run the `nazi_symbols_classification_backend` locally with docker compose::
$ docker compose run --service-ports nazi_symbols_classification_backend
The docker image for `nazi_symbols_classification_backend` is published in DockerHub
repository `nazi-symbols-classification-backend `_.
You can pull it with::
docker push chasingcars/nazi-symbols-classification-backend:latest
Send Image to classify
----------------------
Assuming that the `nazi_symbols_classification_backend` is running at `http://localhost:8080` and the
paths of images to be sent are `["dummy_folder/image_1.jpg", "dummy_folder/image_2.png"]`.
To send images to the endpoint `http://localhost:8080/api/v1/classify`, you can do it with python::
import requests
extension_to_content_type = {
"jpg": "image/jpeg",
"jpeg": "image/jpeg",
"png": "image/png"
}
def classify_document(file_paths, api_endpoint):
files = []
for file_path in file_paths:
extension = file_path.split(".")[-1].lower()
content_type = extension_to_content_type[extension]
files.append(("images", (file_path, open(file_path, 'rb'), content_type)))
response = requests.post(api_endpoint,
files=files,
timeout=10)
response.raise_for_status()
result = response.json()
return result
classify_document(["dummy_folder/image_1.jpg", "dummy_folder/image_2.png"],
"http://localhost:8080/api/v1/classify")
or with curl::
curl -X 'POST' \
'http://localhost:8080/api/v1/classify' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'images=@dummy_folder/image_1.jpg;type=image/jpeg'
-F 'images=@dummy_folder/image_2.png;type=image/png'
Maintainers
-----------
..
TODO: List here the people responsible for the development and maintaining of this project.
Format: **Name** - *Role/Responsibility* - Email
* **Zhiwei Zhang** - *Maintainer* - `[email protected] `_