.. _basics-overview:

:octicon:`telescope` Overview
=============================

fairseq2 is a sequence modeling framework designed for research and deployment of advanced machine learning models.
It builds on the strengths of its predecessor, fairseq, with modernized architecture, enhanced extensibility, and streamlined workflows for training and fine-tuning.

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

.. dropdown:: Command Line Interface (CLI)
    :icon: terminal
    :animate: fade-in

    * Unified commands for training, fine-tuning, and evaluating models.

    * Modular options to customize tasks and configurations.

    * Learn more: :ref:`basics-cli`

.. dropdown:: Assets
    :icon: container
    :animate: fade-in

    * Pre-trained models, datasets, and configurations bundled for easy reuse.

    * Simplified asset management for seamless integration.

    * Learn more: :ref:`basics-assets`

.. dropdown:: Model Loader
    :icon: package
    :animate: fade-in

    * A robust mechanism for loading and saving models.

    * Supports checkpointing, versioning, and compatibility.

.. dropdown:: Data Pipeline
    :icon: database
    :animate: fade-in

    * Extensible pipeline for preprocessing, augmentation, and batching.

    * Optimized for large-scale datasets and varied formats.

    * Learn more: :ref:`basics-data-pipeline`


.. dropdown:: Gang
    :icon: server
    :animate: fade-in

    * A novel abstraction for distributed tasks and parallel processing.

    * Simplifies workload distribution and resource management.

Design Principles
-----------------


.. dropdown:: Dependency Inversion
    :icon: infinity
    :animate: fade-in

    * Decouples components to promote flexibility and testing.

    * Encourages the development of reusable modules.

    * Learn more: :ref:`basics-design-philosophy`

.. dropdown:: Simplicity
    :icon: check
    :animate: fade-in

    * Emphasizes clear APIs and intuitive workflows.

    * Minimizes boilerplate code and unnecessary complexity.

.. dropdown:: Modularity
    :icon: plug
    :animate: fade-in

    * Designed with modularity in mind.

    * Easy to add new datasets, models and trainers.

    * Learn more: :ref:`basics-runtime-extensions`

.. dropdown:: Performance
    :icon: flame
    :animate: fade-in

    * Optimized for scalability and efficiency.

    * Supports state-of-the-art techniques for distributed training.

.. dropdown:: Community-Centric
    :icon: heart
    :animate: fade-in

    * Active collaboration and contributions from the research community.

    * Comprehensive documentation and resources for onboarding.

    * Learn more: :ref:`faq-contributing`