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

.. currentmodule:: pydvid

.. _general:

general
-------

.. note:: All functions in this module can be used directly from the ``pydvid.general`` namespace, e.g. ``pydvid.general.get_server_info()``

.. automodule:: pydvid.general.general
   :members:    

keyvalue
--------

.. note:: All functions in this module can be used directly from the ``pydvid.keyvalue`` namespace, e.g. ``pydvid.keyvalue.get_value(...)``

.. automodule:: pydvid.keyvalue.keyvalue
   :members:

voxels
------

.. note:: All members of this module can be used directly from the ``pydvid.voxels`` namespace, e.g. ``pydvid.voxels.VoxelsAccessor``

.. note:: Please see the :ref:`quickstart <quickstart>` documentation for examples and important usage notes regarding the ``voxels`` API.

.. currentmodule:: pydvid.voxels

.. automodule:: pydvid.voxels.voxels
   :members:

.. currentmodule:: pydvid.voxels.voxels_metadata

.. autoclass:: pydvid.voxels.VoxelsMetadata
   :members:
   
   .. automethod:: __init__

.. currentmodule:: pydvid.voxels.voxels_accessor

.. autoclass:: pydvid.voxels.VoxelsAccessor
   :members:

   .. automethod:: __init__

   .. _slicing:

   .. automethod:: __getitem__
   .. automethod:: __setitem__
   <commit_msg>docs: Fix github pages build.<commit_after>API Reference
=============

.. currentmodule:: pydvid

.. _general:

general
-------

.. note:: All functions in this module can be used directly from the ``pydvid.general`` namespace, e.g. ``pydvid.general.get_server_info()``

.. automodule:: pydvid.general.general
   :members:    

keyvalue
--------

.. note:: All functions in this module can be used directly from the ``pydvid.keyvalue`` namespace, e.g. ``pydvid.keyvalue.get_value(...)``

.. automodule:: pydvid.keyvalue.keyvalue
   :members:

voxels
------

.. note:: All members of this module can be used directly from the ``pydvid.voxels`` namespace, e.g. ``pydvid.voxels.VoxelsAccessor``

.. note:: Please see the :ref:`quickstart <quickstart>` documentation for examples and important usage notes regarding the ``voxels`` API.

.. currentmodule:: pydvid.voxels

.. automodule:: pydvid.voxels.voxels
   :members:

.. currentmodule:: pydvid.voxels.voxels_metadata

.. autoclass:: pydvid.voxels.VoxelsMetadata
   :members:
   
   .. automethod:: __init__

.. currentmodule:: pydvid.voxels.voxels_accessor

.. _slicing:

.. autoclass:: pydvid.voxels.VoxelsAccessor
   :members:

   .. automethod:: __init__
   .. automethod:: __getitem__
   .. automethod:: __setitem__
   
{'fraction_non_alphanumeric': 0.1553627760252366, 'fraction_numerical': 0.0, 'mean_word_length': 3.51423487544484, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, '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': '2327663', 'n_tokens_mistral': 863, 'n_tokens_neox': 849, 'n_words': 210}