diff --git a/doc/glossary/index.rst b/doc/glossary/index.rst new file mode 100644 index 000000000..431019c78 --- /dev/null +++ b/doc/glossary/index.rst @@ -0,0 +1,79 @@ +Glossary +======== + +.. glossary:: + + block + The unit of decompression, stored within a chunk. Blocks are sized to + fit CPU caches, typically 32-512KB. + + BUCKET + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. + + chunk + The unit of storage and compression, stored within a SChunk. Chunks are + sized to fit disk/network I/O, typically 1-64MB. + + clevel + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. + + codec (:class:`API `) + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. + + compression parameters (:class:`API `) + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. + + CTable (:ref:`API `) + A columnar table for structured data. Columns are stored, compressed, and + queried independently, with SUMMARY indexes available by default. Use with + structured data that benefits from compression, speed, and persistence. + + filters (:class:`API `) + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. + + frame + A serialized format for storing chunks along with a header and trailer for + metadata. Frames may be contiguous (CFrame) or sparse (SFrame). + + FULL + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. + + LazyArray (:ref:`API `) + API to store an expression or function and delay computation until the + value is explicitly requested. Executes and stores results chunk-by-chunk. + + LaxyExpr (:ref:`API `) + Object that stores an expression consisting of at least one NDArray + object. Follows the LazyArray API for storage and deferred computation. + + NDArray (:ref:`API `) + A compressed, chunked multidimensional data array. Supports NumPy-like + slicing and broadcasting, and out-of-core computation. Backed by an SChunk. + Use for array workloads, especially when too large to fit in memory + uncompressed. + + OPSI + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. + + PARTIAL + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. + + SChunk (:ref:`API `) + The foundational container for managing a sequence of individual, + compressed chunks. NDArrays and CTable columns are built on top of SChunk. + Use when you want to directly manipulate raw compresesd data and metadata. + + subblock + An indexing segment within a block. One eighth the length of a block. + + SUMMARY + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. diff --git a/doc/python-blosc2.rst b/doc/python-blosc2.rst index e932d3a7c..b817b6d94 100644 --- a/doc/python-blosc2.rst +++ b/doc/python-blosc2.rst @@ -224,5 +224,6 @@ Tutorials Guides API Reference + Glossary Development Release Notes