Deploying to gh-pages from @ nv-legate/legate.internal@374889b 🚀

_sources/api/cpp/data.rst.txt

@@ -0,0 +1,6 @@
+~~~~
+Data
+~~~~
+
+.. doxygengroup:: data
+   :protected-members:

_sources/api/cpp/index.rst.txt

@@ -0,0 +1,24 @@
+~~~~~~~~~~~~~~~~~
+C++ API Reference
+~~~~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 1
+
+   data
+   partitioning
+   runtime
+   mapping
+   types
+   typedefs
+   task
+   util
+
+Experimental API
+----------------
+
+.. toctree::
+   :maxdepth: 1
+
+   io
+   ../../legate.stl/source/reference/index

_sources/api/cpp/io.rst.txt

@@ -0,0 +1,18 @@
+~~~
+IO
+~~~
+
+.. doxygengroup:: io
+   :members:
+
+HDF5
+====
+
+.. doxygengroup:: io-hdf5
+   :members:
+
+KVikIO
+======
+
+.. doxygengroup:: io-kvikio
+   :members:

_sources/api/cpp/mapping.rst.txt

@@ -0,0 +1,26 @@
+~~~~~~~
+Mapping
+~~~~~~~
+
+Mapping tasks that create buffers during execution
+--------------------------------------------------
+
+From the 25.01 release, a task variant that creates temporary or output buffers
+during execution requires the following two steps for correct mapping:
+
+- The variant should be registered with a ``VariantOptions`` with the
+  ``has_allocations`` field set to ``true`` (the default value is ``false``).
+
+- The mapper should return an upper bound of the total size of allocations in
+  the ``allocation_pool_size()`` call. The mapper can choose to give an
+  "unbounded" allocation pool by returning ``std::nullopt``. This is always a
+  sound answer to give from the mapper, but incurs performance penalty that
+  mapping of any downstream tasks creating fresh allocations is blocked.
+
+The allocation pool size is specific to each kind of memory to which the
+executing processor has affinity, and the mapper is queried once for each
+memory kind. The runtime does not call ``allocation_pool_size()`` for task
+variants registered with ``has_allocations`` being ``false``.
+
+.. doxygengroup:: mapping
+    :members:

_sources/api/cpp/partitioning.rst.txt

@@ -0,0 +1,6 @@
+~~~~~~~~~~~~
+Partitioning
+~~~~~~~~~~~~
+
+.. doxygengroup:: partitioning
+    :members:

_sources/api/cpp/runtime.rst.txt

@@ -0,0 +1,6 @@
+~~~~~~~
+Runtime
+~~~~~~~
+
+.. doxygengroup:: runtime
+   :protected-members:

_sources/api/cpp/task.rst.txt

@@ -0,0 +1,5 @@
+~~~~
+Task
+~~~~
+
+.. doxygengroup:: task

_sources/api/cpp/typedefs.rst.txt

@@ -0,0 +1,29 @@
+~~~~~~~~
+Typedefs
+~~~~~~~~
+
+Geometry
+--------
+
+.. doxygengroup:: geometry
+
+
+Accessor
+--------
+
+.. doxygengroup:: accessor
+
+Iterator
+--------
+
+.. doxygengroup:: iterator
+
+Machine
+-------
+
+.. doxygengroup:: machine
+
+Reduction
+---------
+
+.. doxygengroup:: reduction

_sources/api/cpp/types.rst.txt

@@ -0,0 +1,5 @@
+~~~~~
+Types
+~~~~~
+
+.. doxygengroup:: types

_sources/api/cpp/util.rst.txt

@@ -0,0 +1,5 @@
+~~~~
+Util
+~~~~
+
+.. doxygengroup:: util

_sources/api/index.rst.txt

@@ -0,0 +1,9 @@
+API Reference
+=============
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Contents:
+
+  Python API Reference <python/index.rst>
+  C++ API Reference <cpp/index.rst>

_sources/api/python/classes.rst.txt

@@ -0,0 +1,14 @@
+-------
+Classes
+-------
+
+.. toctree::
+   :maxdepth: 2
+
+   runtime
+   operation
+   logical_store
+   machine
+   shape
+.. partition
+.. legion

_sources/api/python/generated/legate.core.Annotation.__init__.rst.txt

@@ -0,0 +1,6 @@
+legate.core.Annotation.\_\_init\_\_
+===================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: Annotation.__init__

_sources/api/python/generated/legate.core.AutoTask.add_alignment.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.add\_alignment
+===================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.add_alignment

_sources/api/python/generated/legate.core.AutoTask.add_broadcast.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.add\_broadcast
+===================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.add_broadcast

_sources/api/python/generated/legate.core.AutoTask.add_constraint.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.add\_constraint
+====================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.add_constraint

_sources/api/python/generated/legate.core.AutoTask.add_cpu_communicator.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.add\_cpu\_communicator
+===========================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.add_cpu_communicator

_sources/api/python/generated/legate.core.AutoTask.add_input.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.add\_input
+===============================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.add_input

_sources/api/python/generated/legate.core.AutoTask.add_nccl_communicator.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.add\_nccl\_communicator
+============================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.add_nccl_communicator

_sources/api/python/generated/legate.core.AutoTask.add_output.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.add\_output
+================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.add_output

_sources/api/python/generated/legate.core.AutoTask.add_reduction.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.add\_reduction
+===================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.add_reduction

_sources/api/python/generated/legate.core.AutoTask.add_scalar_arg.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.add\_scalar\_arg
+=====================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.add_scalar_arg

_sources/api/python/generated/legate.core.AutoTask.declare_partition.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.declare\_partition
+=======================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.declare_partition

_sources/api/python/generated/legate.core.AutoTask.execute.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.execute
+============================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.execute

_sources/api/python/generated/legate.core.AutoTask.set_concurrent.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.set\_concurrent
+====================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.set_concurrent

_sources/api/python/generated/legate.core.AutoTask.set_side_effect.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.set\_side\_effect
+======================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.set_side_effect

_sources/api/python/generated/legate.core.AutoTask.throws_exception.rst.txt

@@ -0,0 +1,6 @@
+legate.core.AutoTask.throws\_exception
+======================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: AutoTask.throws_exception

_sources/api/python/generated/legate.core.LogicalStore.delinearize.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.delinearize
+====================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: LogicalStore.delinearize

_sources/api/python/generated/legate.core.LogicalStore.ndim.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.ndim
+=============================
+
+.. currentmodule:: legate.core
+
+.. autoattribute:: LogicalStore.ndim

_sources/api/python/generated/legate.core.LogicalStore.partition_by_tiling.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.partition\_by\_tiling
+==============================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: LogicalStore.partition_by_tiling

_sources/api/python/generated/legate.core.LogicalStore.project.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.project
+================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: LogicalStore.project

_sources/api/python/generated/legate.core.LogicalStore.promote.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.promote
+================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: LogicalStore.promote

_sources/api/python/generated/legate.core.LogicalStore.shape.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.shape
+==============================
+
+.. currentmodule:: legate.core
+
+.. autoattribute:: LogicalStore.shape

_sources/api/python/generated/legate.core.LogicalStore.size.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.size
+=============================
+
+.. currentmodule:: legate.core
+
+.. autoattribute:: LogicalStore.size

_sources/api/python/generated/legate.core.LogicalStore.slice.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.slice
+==============================
+
+.. currentmodule:: legate.core
+
+.. automethod:: LogicalStore.slice

_sources/api/python/generated/legate.core.LogicalStore.transformed.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.transformed
+====================================
+
+.. currentmodule:: legate.core
+
+.. autoattribute:: LogicalStore.transformed

_sources/api/python/generated/legate.core.LogicalStore.transpose.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.transpose
+==================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: LogicalStore.transpose

_sources/api/python/generated/legate.core.LogicalStore.type.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.type
+=============================
+
+.. currentmodule:: legate.core
+
+.. autoattribute:: LogicalStore.type

_sources/api/python/generated/legate.core.LogicalStore.unbound.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStore.unbound
+================================
+
+.. currentmodule:: legate.core
+
+.. autoattribute:: LogicalStore.unbound

_sources/api/python/generated/legate.core.LogicalStorePartition.store.rst.txt

@@ -0,0 +1,6 @@
+legate.core.LogicalStorePartition.store
+=======================================
+
+.. currentmodule:: legate.core
+
+.. automethod:: LogicalStorePartition.store

_sources/api/python/generated/legate.core.Machine.__and__.rst.txt

@@ -0,0 +1,6 @@
+legate.core.Machine.\_\_and\_\_
+===============================
+
+.. currentmodule:: legate.core
+
+.. automethod:: Machine.__and__