com.io7m.laurel

laurel

The laurel package 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 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.

Usage

See the documentation.

Releases & Development Snapshots

Releases

You can subscribe to the atom feed to be notified of project releases.

The most recently released version of the package is 0.99.0.

0.99.0 Release (2024-09-29Z)

The compiled artifacts for the release (and all previous releases) are available on Maven Central.

Maven Modules

<dependency> <group>com.io7m.laurel</group> <artifactId>com.io7m.laurel.cmdline</artifactId> <version>0.99.0</version> </dependency><dependency> <group>com.io7m.laurel</group> <artifactId>com.io7m.laurel.distribution</artifactId> <version>0.99.0</version> </dependency><dependency> <group>com.io7m.laurel</group> <artifactId>com.io7m.laurel.documentation</artifactId> <version>0.99.0</version> </dependency><dependency> <group>com.io7m.laurel</group> <artifactId>com.io7m.laurel.filemodel</artifactId> <version>0.99.0</version> </dependency><dependency> <group>com.io7m.laurel</group> <artifactId>com.io7m.laurel.gui.main</artifactId> <version>0.99.0</version> </dependency><dependency> <group>com.io7m.laurel</group> <artifactId>com.io7m.laurel.gui</artifactId> <version>0.99.0</version> </dependency><dependency> <group>com.io7m.laurel</group> <artifactId>com.io7m.laurel.model</artifactId> <version>0.99.0</version> </dependency><dependency> <group>com.io7m.laurel</group> <artifactId>com.io7m.laurel.tests</artifactId> <version>0.99.0</version> </dependency>

Development Snapshots

At the time of writing, the current unstable development version of the package is 0.99.1-SNAPSHOT.

Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.

Manual

User Manual

• XHTML - One page per section
• XHTML - Single page

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/laurel

$ git clone --recursive https://www.github.com/io7m-com/laurel

Issues

This project uses GitHub Issues to track issues.

License

Copyright © 2024 Mark Raynsford <[email protected]> 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.