.. Atlas documentation master file

Welcome to Atlas Documentation
============================================

.. image:: _static/logo.png
   :alt: Atlas Logo
   :align: center
   :width: 400px

.. raw:: html

   <div style="text-align: center; margin: 20px 0;">
      <strong>Adaptable Toolset for Learning And Strategy</strong>
   </div>

Atlas empowers data-driven organizations to maximize ROI through intelligent business optimizations across diverse models and business scenarios.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started
   :hidden:

   introduction
   quickstart 

.. toctree::
   :maxdepth: 2
   :caption: Core Concepts
   :hidden:

   concepts/core
   concepts/data
   concepts/models
   concepts/optimization
   concepts/constraints
   
.. toctree::
   :maxdepth: 2
   :caption: Features
   :hidden:

   features/overview


.. toctree::
   :maxdepth: 2
   :caption: Design Guides
   :hidden:

   guides/black_box_model
   guides/model_integration
   guides/custom_optimization
   guides/optimization_strategies
   guides/production_deployment
   guides/configuration

.. toctree::
   :maxdepth: 2
   :caption: API Reference
   :hidden:

   api/index

.. toctree::
   :maxdepth: 2
   :caption: Examples
   :hidden:

   examples/marketing_mix
   examples/scikit_learn

.. toctree::
   :maxdepth: 1
   :caption: Additional Resources
   :hidden:

   changelog
   contributing
   faq
   glossary

Quick Links
-----------

.. grid:: 2 2 4 4
   :gutter: 2

   .. grid-item-card:: 🚀 Quick Start
      :link: quickstart
      :link-type: doc

      Get up and running with Atlas in minutes

   .. grid-item-card:: 📚 Features
      :link: features/overview
      :link-type: doc

      Explore the comprehensive feature set

   .. grid-item-card:: 🔧 Model Integration
      :link: guides/model_integration
      :link-type: doc

      Learn how to integrate your models

   .. grid-item-card:: 📊 Optimization Strategies
      :link: guides/optimization_strategies
      :link-type: doc

      Design custom optimization strategies

Key Features
------------

**Model Agnostic**
   Seamlessly integrate any predictive model - ML, statistical, or API-based

**Multi-Objective Optimization**
   Balance competing objectives like revenue, awareness, and efficiency

**Enterprise Ready**
   Production-grade with Docker support, monitoring, and horizontal scaling

**Extensible Architecture**
   Plugin system for custom models, strategies, and constraints

Latest Updates
--------------

.. include:: changelog.rst
   :start-line: 3
   :end-line: 20

Getting Help
------------

* **Documentation**: You're here! 📖
* **GitHub**: `github.com/redam94/atlas <https://github.com/redam94/atlas>`_
* **Issues**: `Report bugs or request features <https://github.com/redam94/atlas/issues>`_


License
-------

Atlas is open source software licensed under the APGL license for non-commercial use.