<commit_before>API Reference
=============

Scanner has three main components to its API:

* The :ref:`Scanner Python API <scannerpy-docs>`, for defining/executing computation graphs and Python kernels
* The `Scanner C++ API <TODO>`_, for defining C++ kernels
* The :ref:`Scannertools API <scannertools-docs>`, a standard library of premade kernels

.. _scannerpy-docs:

scannerpy - the main scanner API
--------------------------------

* :any:`scannerpy.client`: entrypoint for running computation graphs, similar to TensorFlow Session
* :any:`scannerpy.kernel`: defining custom Python kernels
* :any:`scannerpy.storage`: defining custom inputs/outputs to Scanner graphs
* :any:`scannerpy.kube`: Kubernetes API
* :any:`scannerpy.profiler`: handle to profiling data output by Scanner

.. _scannertools-docs:

scannertools - the Scanner standard library
-------------------------------------------

.. toctree::
   :maxdepth: 3

   api/scannertools
<commit_msg>Fix C++ link<commit_after>API Reference
=============

Scanner has three main components to its API:

* The :ref:`Scanner Python API <scannerpy-docs>`, for defining/executing computation graphs and Python kernels
* The `Scanner C++ API </cpp/>`_, for defining C++ kernels
* The :ref:`Scannertools API <scannertools-docs>`, a standard library of premade kernels

.. _scannerpy-docs:

scannerpy - the main scanner API
--------------------------------

* :any:`scannerpy.client`: entrypoint for running computation graphs, similar to TensorFlow Session
* :any:`scannerpy.kernel`: defining custom Python kernels
* :any:`scannerpy.storage`: defining custom inputs/outputs to Scanner graphs
* :any:`scannerpy.kube`: Kubernetes API
* :any:`scannerpy.profiler`: handle to profiling data output by Scanner

.. _scannertools-docs:

scannertools - the Scanner standard library
-------------------------------------------

.. toctree::
   :maxdepth: 3

   api/scannertools

{'fraction_non_alphanumeric': 0.1841831425598335, 'fraction_numerical': 0.001040582726326743, 'mean_word_length': 3.40045766590389, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1816105', 'n_tokens_mistral': 557, 'n_tokens_neox': 529, 'n_words': 182}