.. Ovative Group Image Caption Generator documentation master file, created by
   sphinx-quickstart on Mon Apr 22 16:56:29 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the Ovative Group Image Caption Generator's documentation!
=====================================================================

.. raw:: html

    <style> .orange {color:#fa4616; font-weight:bold; font-size:16px} </style>

.. role:: orange

.. figure:: ./_static/octopus.png

This project was created by NDSU's 2024 Capstone class. Contributors are: Ian King, Omar Elsegeiny, Mason Myles,
Bohdan Ivanyshyn, and Emily Anderson.


The Problem
-----------

:orange:`Ovative Group` is a digital media and marketing firm that provides analysis of their clients' ads. However, in
order to analyze the ads, they need to describe them. This is often time intensive. They came to us with the request to
design an Image Captioning program that would allow the advertisements to be analyzed easier.


Our Solution
------------

A command-line interface that intakes one or multiple images from a URL(s) or a directory. It then runs the images
through several models and returns those captions in a CSV file. This CSV file, once created, then compiles all future
captions in one place to allow for easier analysis.


.. figure:: ./_static/logo.png


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   overview
   sales_force_model
   cohere_model
   easyocr
   app
   threads
   utils
   sources