Caption Me: Simplifying Image Captioning

Caption Me is designed to streamline the creation, management, and updating of image captions, empowering you to focus on what really matters.

---

collage style, woman, looking at viewer, torn paper, magazine, newspaper

---

• Introduction
• Prerequisites
• Installation
  • Automated Installer (Windows)
  • Manual Setup
• Quickstart
  • Clone repo
  • Windows
  • macOS/Linux
• Usage Guide: Mastering Caption Me
  • Navigating the Interface
  • Directory Selection
  • Working with Images
  • Captioning and Autocomplete
  • Advanced Autocomplete Usage
  • Saving Your Work
• Feedback & Support

---

A modern interface dedicated to your captioning needs.

---

Introduction

Caption Me is built to simplify the image captioning process. Whether you're a professional or a hobbyist, setting up Caption Me is straightforward and intuitive.

Prerequisites

To ensure a seamless experience, please install the following software:

• Python 3: Back-end operations
  • Download Python 3
• Node.js 18: Dependency management
  • Download Node.js 18
• Git: Source code retrieval
  • Download Git

---

Installation

Automated Installer (Windows)

1. Download: Obtain the one-click-installer.bat here.
2. Execute: Double-click the .bat file.
3. Launch: Open run.sh in the newly-created caption-me directory.

Note: Re-running one-click-installer.bat updates the software. Store it separately for convenience.

├── caption-me-root
│   ├── one-click-installer.bat
│   └── caption-me (auto-generated)

Manual Setup

For Unix-based systems, follow these instructions:

1. Clone Repository

   git clone git@github.com:failfa-st/caption-me.git

2. Enter Directory

   cd caption-me

3. Install Dependencies

   npm install

4. Compile App

   npm run build

5. Run App

   npm start

---

Quickstart

Clone repo

git clone git@github.com:failfa-st/caption-me.git

Windows

• Install: Double-click install.bat
• Run: Double-click run.bat

macOS/Linux

• One-liner:

  npm install && npm run build && npm start

---

Usage Guide: Mastering Caption Me

Caption Me is designed to be user-friendly, yet offers a range of features to facilitate your captioning process. Below is a detailed guide on how to get the most out of the tool.

---

Navigating the Interface

When you launch Caption Me, you'll notice the main interface divided into specific sections for ease of use. Your working directory, image list, preview pane, and caption editor all have dedicated spaces.

---

Directory Selection

1. Select Directory: To begin, either click the folder icon located at the left of the input field at the top or manually paste the directory path.

• After entering the path, click the adjacent load/reload button.

2. Reload Directory: If you've made changes to the directory, such as adding or deleting images, click the load/reload button to refresh the image list.

3. Clear Cache (optional): To ensure that the app recognizes new changes in the directory, especially new or deleted images, use the clear cache button next to the load/reload button.

---

Working with Images

4. Browse Image List: Once a directory is loaded, you'll see a scrollable list of images on the left side of the interface. Each image listed here also displays its title and caption status.
   • A red/green indicator next to the image signifies whether a caption exists for that image.

5. Preview Image: Above this image list is a preview pane where a larger version of the currently selected image will be displayed, aiding in more accurate captioning.

6. Select an Image: To work on a specific image, simply click on it from the list to load it into the preview pane and activate the caption editor.

---

Captioning and Autocomplete

7. Caption Editor: Upon selecting an image, an autocomplete field activates. Begin typing your caption here.

8. Utilize Autocomplete: As you type, the autocomplete feature suggests known terms to speed up your captioning process.

9. Undo/Redo: History functions, including undo and redo, are available next to the autocomplete field. These are cleared each time you switch to a different image.

   

Advanced Autocomplete Usage

10. Drag and Sort: Within the autocomplete tags, you can drag and sort the listed terms.

11. Batch Entry: For a quicker way to insert multiple terms, you can type them in a single line, separated by commas. Once you press Enter, these will automatically be split into separate tags.

---

Saving Your Work

12. Automatic Save: Caption Me automatically saves changes to the caption when you switch between images.

13. Manual Save: For explicit saving, click the save icon situated next to the history buttons.

---

Feedback & Support

We value your input. Reach out to us through these channels:

• Chat: Engage with our Discord community.
• Issue Tracker: Encountered a bug? Report it on GitHub Issues.

---

Tailor your captioning experience with Caption Me. Thank you for choosing us.