.. image:: https://raw.githubusercontent.com/lRomul/argus/master/assets/logo/argus_logo.png
    :target: https://github.com/lRomul/argus
    :alt: Argus logo

Argus is a lightweight library for training neural networks in PyTorch.

Installation
============

Requirements:

* torch>=2.0.0

You can use pip to install Argus:

.. code:: bash

    pip install pytorch-argus

If you want to get the latest version of the code before it is released on PyPI you can install the library from GitHub:

.. code:: bash

    pip install -U git+https://github.com/lRomul/argus.git@dev

Documentation
=============

.. toctree::
   :maxdepth: 2

   quickstart
   guides
   examples
   api_reference/index

Why this name, Argus?
=====================

The library name is a reference to a planet from World of Warcraft.
Argus is the original homeworld of the eredar (a race of supremely talented magic-wielders), now located within the Twisting Nether.
It was once described as a utopian world whose inhabitants were both vastly intelligent and highly gifted in magic.
It has since been twisted by demonic, chaotic energies and became the stronghold and homeworld of the Burning Legion.