.. _page-interactive-api:

***********
Interactive
***********

The ``rail.interactive`` module provides a set of functions that act as replacements for
the class-based system of running RAIL, which is now primarily used for Pipeline Mode.

These functions are generated at runtime from the RailStage classes and therefore do not
have viewable source code.

The docstrings given below are created from the RailStage classes and their primary
method (called the *entrypoint function*), and can be seen by users by inspecting the
function objects. 

They are updated along with pz-rail-base, but the content of them is generated from the algorithm packages, using the versions that were available when this documentation was generated.
Therefore, if your installed version of pz-rail-base differs from the current version, this documentation *may* not match the docstrings available on your machine.


.. toctree::
   :maxdepth: 4

   api/rail.interactive.creation
   api/rail.interactive.estimation
   api/rail.interactive.evaluation
   api/rail.interactive.tools