update readme.md

This commit is contained in:
Denis-Cosmin NUTIU 2024-03-30 13:15:57 +02:00
parent ccd463d3f5
commit a9119eeb72
3 changed files with 60 additions and 37 deletions

View file

@ -4,20 +4,8 @@
<option name="autoReloadType" value="SELECTIVE" />
</component>
<component name="ChangeListManager">
<list default="true" id="dac8f85c-5bd6-4e05-9520-9e6a91c7f78e" name="Changes" comment="extract common ai-related functionality into img-ai">
<change afterPath="$PROJECT_DIR$/img-ai/src/main/java/module-info.java" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/img-ai/build.gradle.kts" beforeDir="false" afterPath="$PROJECT_DIR$/img-ai/build.gradle.kts" afterDir="false" />
<change beforePath="$PROJECT_DIR$/img-ai/src/main/kotlin/ImageTagsPrediction.kt" beforeDir="false" afterPath="$PROJECT_DIR$/img-ai/src/main/kotlin/dev/nuculabs/imagetagger/ai/ImageTagsPrediction.kt" afterDir="false" />
<change beforePath="$PROJECT_DIR$/img-ui/build.gradle" beforeDir="false" afterPath="$PROJECT_DIR$/img-ui/build.gradle" afterDir="false" />
<change beforePath="$PROJECT_DIR$/img-ui/src/main/java/module-info.java" beforeDir="false" afterPath="$PROJECT_DIR$/img-ui/src/main/java/module-info.java" afterDir="false" />
<change beforePath="$PROJECT_DIR$/img-ui/src/main/kotlin/dev/nuculabs/imagetagger/ai/ImageTagsPrediction.kt" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/img-ui/src/main/resources/dev/nuculabs/imagetagger/ai/prediction_categories.txt" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/img-ui/src/test/kotlin/ai/ImageTagsPredictionTests.kt" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/img-ui/src/test/resources/ai/timisoara-bega.jpg" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/img-ui/src/test/resources/ai/timisoara-threes.jpg" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/img-ui/src/test/resources/ai/timisoara-water-tower.jpg" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/settings.gradle" beforeDir="false" afterPath="$PROJECT_DIR$/settings.gradle" afterDir="false" />
<list default="true" id="dac8f85c-5bd6-4e05-9520-9e6a91c7f78e" name="Changes" comment="add module-info.java">
<change beforePath="$PROJECT_DIR$/readme.md" beforeDir="false" afterPath="$PROJECT_DIR$/readme.md" afterDir="false" />
</list>
<option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" />
@ -54,24 +42,6 @@
<item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
<item name="ImageTagger-Solution" type="f1a62948:ProjectNode" />
</path>
<path>
<item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
<item name="ImageTagger-Solution" type="f1a62948:ProjectNode" />
<item name="img-ui" type="2d1252cf:ModuleNode" />
</path>
<path>
<item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
<item name="ImageTagger-Solution" type="f1a62948:ProjectNode" />
<item name="img-ui" type="2d1252cf:ModuleNode" />
<item name="Tasks" type="e4a08cd1:TasksNode" />
</path>
<path>
<item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
<item name="ImageTagger-Solution" type="f1a62948:ProjectNode" />
<item name="img-ui" type="2d1252cf:ModuleNode" />
<item name="Tasks" type="e4a08cd1:TasksNode" />
<item name="distribution" type="c8890929:TasksNode$1" />
</path>
</expand>
<select />
</tree_state>
@ -290,7 +260,7 @@
<option name="presentableId" value="Default" />
<updated>1711789328334</updated>
<workItem from="1711789330084" duration="2109000" />
<workItem from="1711791444105" duration="4216000" />
<workItem from="1711791444105" duration="4705000" />
</task>
<task id="LOCAL-00001" summary="split ImageTagger into subproject img-ui">
<option name="closed" value="true" />
@ -324,7 +294,15 @@
<option name="project" value="LOCAL" />
<updated>1711793501074</updated>
</task>
<option name="localTasksCounter" value="5" />
<task id="LOCAL-00005" summary="add module-info.java">
<option name="closed" value="true" />
<created>1711796896478</created>
<option name="number" value="00005" />
<option name="presentableId" value="LOCAL-00005" />
<option name="project" value="LOCAL" />
<updated>1711796896478</updated>
</task>
<option name="localTasksCounter" value="6" />
<servers />
</component>
<component name="TypeScriptGeneratedFilesManager">
@ -335,7 +313,8 @@
<MESSAGE value="update readme.md" />
<MESSAGE value="update gradle config" />
<MESSAGE value="extract common ai-related functionality into img-ai" />
<option name="LAST_COMMIT_MESSAGE" value="extract common ai-related functionality into img-ai" />
<MESSAGE value="add module-info.java" />
<option name="LAST_COMMIT_MESSAGE" value="add module-info.java" />
</component>
<component name="XDebuggerManager">
<breakpoint-manager>

43
img-ai/.gitignore vendored
View file

@ -1,2 +1,45 @@
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/
### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml
.idea/compiler.xml
.idea/libraries/
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/
### Eclipse ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
### VS Code ###
.vscode/
### Mac OS ###
.DS_Store
# Deep learning models
src/main/resources/dev/nuculabs/imagetagger/ai/*.onnx

View file

@ -10,7 +10,7 @@ It allows photographers to automate the image tagging process. 📸
1. Download a release from the release page.
2. Unzip the release.
3. Run `ImageTagger-win\image\bin\app` or `ImageTagger-win\image\bin\ImageTagger` when available.
3. Run `ImageTagger-win\image\bin\app` or `ImageTagger-win\image\bin\ImageTagger`.
![./docs/application.png](./docs/application.png)
@ -29,7 +29,8 @@ The release archive is in the [releases page](https://github.com/dnutiu/ImageTag
To build from source you will need Java 17 JDK and Gradle.
Due to some GitHub limitations that do not allow me to upload large files, you'll need to download the AIModels
zip file which contains the deep learning models and place them into the `ImageTagger/img-ui/src/main/resources/dev/nuculabs/imagetagger/ai` path.
zip file which contains the deep learning models and place them into the
`ImageTagger/img-ai/src/main/resources/dev/nuculabs/imagetagger/ai/` path.
To build the project run: