.. _user-guide-index:

.. toctree::
    :maxdepth: 2
    :caption: Introduction to ARTKIT
    :hidden:

    introduction_to_artkit/genai_testing_and_evaluation
    introduction_to_artkit/building_your_first_artkit_pipeline
    introduction_to_artkit/connecting_to_genai_models

.. toctree::
    :maxdepth: 2
    :caption: Generating Challenges
    :hidden:
  
    generating_challenges/prompt_augmentation
    generating_challenges/single_turn_personas
    generating_challenges/multi_turn_personas

.. toctree::
    :maxdepth: 2
    :caption: Multimodal Models
    :hidden:
  
    multimodal/image_generation_and_evaluation

.. toctree::
    :maxdepth: 2
    :caption: Evaluation and Analysis
    :hidden:
  
    evaluation_and_analysis/evaluator_design
    evaluation_and_analysis/interpreting_run_results

.. toctree::
    :maxdepth: 2
    :caption: Advanced Tutorials
    :hidden:
  
    advanced_tutorials/creating_new_model_classes    
    advanced_tutorials/prompt_formatting
    advanced_tutorials/cache_management
    advanced_tutorials/json_output_validation
    advanced_tutorials/advanced_design_patterns


User Guide
==========

This section provides comprehensive guidance for ARTKIT users, with content organized in five sections:

- **Introduction to ARTKIT**:
  Core concepts and mechanics of using ARTKIT
- **Generating Challenges**:
  Generating test prompts for Gen AI systems
- **Multimodal Models**:
  Use ARTKIT with multimodal models
- **Evaluation and Analysis**:
  Develop robust evaluators and analyze results
- **Advanced Tutorials**:
  Deep dive on advanced ARTKIT functionality and design patterns

For practical guidance on applying ARTKIT in realistic use cases, see our `Examples <../examples/index.rst>`_ section.


Contributing to Our User Guide
------------------------------

We are committed to continuously improving our User Guide to ensure it meets the needs of our users and accurately reflects 
the breadth and depth of use cases for ARTKIT.

To this end, we encourage contributions from our community. Whether you've identified an opportunity for enhancement, 
noticed a crucial piece missing, or have an addition that could benefit others, we invite you to share your expertise.

Should you come across any gaps or areas for improvement, do not hesitate to open an issue on our 
`issue tracker <https://github.com/BCG-X-Official/artkit/issues>`_. 
Your contributions help us make our User Guide a more valuable resource for everyone.

Before submitting contributions to the User Guide, please review our :ref:`Contributor Guide <contributor-guide-index>`.
