.. SPDX-FileCopyrightText: Copyright (C) 2026 Omid Jafari <omidjafari.com>
.. SPDX-License-Identifier: AGPL-3.0-or-later
..
.. This program is free software: you can redistribute it and/or modify
.. it under the terms of the GNU Affero General Public License as published by
.. the Free Software Foundation, either version 3 of the License, or
.. (at your option) any later version.
..
.. This program is distributed in the hope that it will be useful,
.. but WITHOUT ANY WARRANTY; without even the implied warranty of
.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.. GNU Affero General Public License for more details.
..
.. You should have received a copy of the GNU Affero General Public License
.. along with this program.  If not, see <http://www.gnu.org/licenses/>.

NLPMed Portal Lite API Reference
================================

NLPMed Portal Lite is the lightweight, self-hosted edition of NLPMed Portal
for clinical natural language processing and annotation workflows.

This site contains the generated Python API reference for version |release|.
Installation, configuration, and command-line usage are documented in the
repository README.

.. important::

   NLPMed Portal Lite is research software. It has not been designed,
   validated, or approved for diagnosis, treatment, or other clinical
   decision-making.

Lite edition
------------

The Lite edition supports PostgreSQL and SQL Server, executes background
operations synchronously, and does not require Celery, Redis, Flower, or the
Full edition's LLM dependencies.

Related software
----------------

External NLP preprocessing and model inference can be provided by
`NLPMed Engine <https://github.com/omid-jf/NLPMed-Engine>`_, which is also
available from `PyPI <https://pypi.org/project/nlpmed-engine/>`_.

API reference
-------------

.. toctree::
   :maxdepth: 2

   api/modules

Indices
-------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`