Merge pull request #20 from lombokai/dev

Merge from dev to main branch

Author: nunenuh

.github/workflows/dev.yaml

@@ -0,0 +1,44 @@
+name: "On Merge dev: Release Dev"
+
+concurrency:
+  group: dev-build-deploy-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - dev
+
+permissions: write-all
+
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Get Latest Tag
+        id: latest-tag
+        run: echo "tag=$(git tag -l | sort -V | tail -1 | sed 's/-dev$//')" >> "$GITHUB_OUTPUT"
+
+      - name: Generate New Bumped Version
+        uses: actions-ecosystem/action-bump-semver@v1
+        id: bump-semver
+        with:
+          current_version: ${{ steps.latest-tag.outputs.tag }}
+          level: patch
+
+      - name: Create Release Notes
+        id: create-release
+        run: |
+          curl -f -X POST \
+          -H "Accept: application/vnd.github.v3+json" \
+          -H "authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+          -H "X-GitHub-Api-Version: 2022-11-28" \
+          https://api.github.com/repos/${{ github.repository }}/releases \
+          -d '{"tag_name":"${{ steps.bump-semver.outputs.new_version }}", "generate_release_notes":true}'

.github/workflows/main.yaml

@@ -0,0 +1,43 @@
+name: "On Merge main: Release Dev"
+
+concurrency:
+  group: main-build-deploy-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions: write-all
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Get Latest Tag
+        id: latest-tag
+        run: echo "tag=$(git tag -l | sort -V | tail -1 | sed 's/-dev$//')" >> "$GITHUB_OUTPUT"
+
+      - name: Generate New Bumped Version
+        uses: actions-ecosystem/action-bump-semver@v1
+        id: bump-semver
+        with:
+          current_version: ${{ steps.latest-tag.outputs.tag }}
+          level: minor
+
+      - name: Create Release Notes
+        id: create-release
+        run: |
+          curl -f -X POST \
+          -H "Accept: application/vnd.github.v3+json" \
+          -H "authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+          -H "X-GitHub-Api-Version: 2022-11-28" \
+          https://api.github.com/repos/${{ github.repository }}/releases \
+          -d '{"tag_name":"${{ steps.bump-semver.outputs.new_version }}", "generate_release_notes":true}'

.gitignore

@@ -166,4 +166,4 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-# data/
+# data/

.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.4.0
+      hooks:
+        - id: fix-byte-order-marker
+        - id: check-yaml
+        - id: end-of-file-fixer
+        - id: requirements-txt-fixer
+        - id: trailing-whitespace
+          args: [--markdown-linebreak-ext=md]
+
+    - repo: https://github.com/myint/autoflake
+      rev: v2.3.1
+      hooks:
+        - id: autoflake
+          args:
+          - --in-place
+          - --remove-all-unused-imports
+          - --remove-unused-variables
+          - --ignore-init-module-imports
+
+    - repo: https://github.com/pycqa/flake8
+      rev: 3.9.2  # Use the latest commit SHA or tag
+      hooks:
+        - id: flake8
+
+    - repo: https://github.com/psf/black
+      rev: 24.4.2
+      hooks:
+        - id: black
+
+    - repo: https://github.com/pycqa/isort
+      rev: 5.13.2
+      hooks:
+        - id: isort
+          name: isort (python)
+
+    # - repo: https://github.com/PyCQA/bandit
+    #   rev: 1.7.5 # Update me!
+    #   hooks:
+    #     - id: bandit
+    #       args: ["--ini", "iquote/.bandit"]
+    #     #   additional_dependencies: ["bandit[toml]"]
+
+    # - repo: https://github.com/Lucas-C/pre-commit-hooks-safety
+    #   rev: v1.3.1
+    #   hooks:
+    #   - id: python-safety-dependencies-check
+    #     # args: ["--disable-telemetry"]

Makefile

@@ -1,2 +1,18 @@
+.PHONY: .venv
+
 run-test:
-	PYTHONPATH=src python -m pytest -v
+ifdef dst
+	PYTHONPATH=.:src python -m pytest $(dst) -v
+else
+	PYTHONPATH=.:src python -m pytest -v
+endif
+
+clear-cache:
+	find . -type d -name '__pycache__' -exec rm -r {} + \
+	&& find . -type f -name '*.pyc' -delete
+
+run-test-cov:
+	@PYTHONPATH=.:app:$PYTHONPATH pytest --cov=app --cov-report=xml
+
+precommit:
+	pre-commit run --all-files

README.md

@@ -1,2 +1,83 @@
-# onepiece-classifier
-An image recognition of one piece anime character
+# Machine Learning Project Documentation
+
+## Project Overview
+This repository contains programs for classifying images. The images used for this project are images of Onepiece anime characters. There are 18 predicted anime characters. This project is packaged in the form of a python package so that it can be used by the public.
+
+## Installation Guide
+### Requirements
+It is recommended to run this application within a virtual environment. First thing first is clone the repository
+
+```sh
+git clone https://github.com/lombokai/onepiece-classifier.git
+```
+### Virtual Environment Setup
+create a virtual environment
+
+```sh
+python3 -m venv <virtual environment name>
+```
+
+command line to activate your virtual environment in linux
+```sh
+source <virtual environment name>/bin/activate
+```
+
+command line to activate your virtual environment in windows
+```sh
+<virtual environment name>\Scripts\activate
+```
+
+install package requirements
+```sh
+pip install -r requirements/main.txt
+```
+
+## Usage
+### Example Usage
+This package provide image to predict in `assets` directory. If you want to try predict an image, run predict.py script with command bellow
+```
+python3 predict.py <image path>
+```
+
+command example if you are working in parent directory of this repo
+
+```sh
+python3 predict.py assets/luffy.png
+```
+
+try to predict different image with command above
+
+### Run the Application
+install onepiece-classify package
+```sh
+pip install onepiece-classify
+```
+
+acces predict method from onepiece-classify pakcage
+
+```python
+from onepiece_classify.infer import ImageRecognition
+```
+
+instantiate the class with your model path. Download trained model [here](https://drive.google.com/file/d/1M1-1Hs198XDD6Xx-kSWLThv1elZBzJ0j/view?usp=sharing) and make sure you specify model path parameter in the location of downloaded model
+
+```python
+predictor = ImageRecognition(<model path>)
+```
+
+then you just predict your image with `predict` method
+```python
+predictor.predict(<your image path>)
+```
+
+
+## Data Description
+### Data Sources
+Data obtained from Kaggle [here](https://www.kaggle.com/datasets/ibrahimserouis99/one-piece-image-classifie). The data contains a collection of 18 onepiece character images, and is saved in jpg, jpeg and png formats.
+
+## Contributing
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+
+## License
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)