com.io7m.laurel
The laurel application attempts to provide tools to assist with image captioning within the context of machine learning.
In particular, the application is geared towards the management of smaller datasets (in the range of thousands of images) for use in techniques such as LORA training.
Features
- A user interface for managing images and captions for those images.
- A caption categorization system for assisting with keeping captions consistent across large datasets.
- The ability to import captions and images into a dataset from a directory hierarchy.
- The ability to export captions and images into a directory for use in training scripts.
- A persistent undo/redo system that can store every change ever made to a dataset, including the ability to effectively revert to an earlier version at any time.
- A carefully-engineered Java API for manipulating datasets; the command-line tools and user interface are thin shells over this API.
- Datasets are backed by [SQLite](https://www.sqlite.org) for reliable, transactional updates, and a file format that is designed to endure for decades to come.
- Command line tools for automating operations such as importing, exporting, and interrogating metadata.
- Comprehensive documentation.
- OSGi-ready
- JPMS-ready
- ISC license
Releases
The most recently published version of the software is 0.99.0.
Source code and binaries are available from the repository.
Documentation
Documentation for the 0.99.0 release is available for reading online.
Documentation for current and older releases is archived in the repository.
User Documentation
Maven
The following is a complete list of the project's modules expressed as Maven dependencies:
<dependency> <groupId>com.io7m.laurel</groupId> <artifactId>com.io7m.laurel</artifactId> <version>0.99.0</version> </dependency> <dependency> <groupId>com.io7m.laurel</groupId> <artifactId>com.io7m.laurel.cmdline</artifactId> <version>0.99.0</version> </dependency> <dependency> <groupId>com.io7m.laurel</groupId> <artifactId>com.io7m.laurel.distribution</artifactId> <version>0.99.0</version> </dependency> <dependency> <groupId>com.io7m.laurel</groupId> <artifactId>com.io7m.laurel.documentation</artifactId> <version>0.99.0</version> </dependency> <dependency> <groupId>com.io7m.laurel</groupId> <artifactId>com.io7m.laurel.filemodel</artifactId> <version>0.99.0</version> </dependency> <dependency> <groupId>com.io7m.laurel</groupId> <artifactId>com.io7m.laurel.gui.main</artifactId> <version>0.99.0</version> </dependency> <dependency> <groupId>com.io7m.laurel</groupId> <artifactId>com.io7m.laurel.gui</artifactId> <version>0.99.0</version> </dependency> <dependency> <groupId>com.io7m.laurel</groupId> <artifactId>com.io7m.laurel.model</artifactId> <version>0.99.0</version> </dependency> <dependency> <groupId>com.io7m.laurel</groupId> <artifactId>com.io7m.laurel.tests</artifactId> <version>0.99.0</version> </dependency>
Each release of the project is made available on Maven Central within ten minutes of the release announcement.
Sources
This project uses Git to manage source code.
Repository: https://www.github.com/io7m-com/laurel
$ git clone https://www.github.com/io7m-com/laurel
License
Copyright © 2024 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Bug Tracker
The project uses GitHub Issues to track issues.