mirror of
https://github.com/zama-ai/concrete.git
synced 2026-02-09 03:55:04 -05:00
docs: improve module docstrings
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
"""
|
||||
Declaration of `concrete` namespace.
|
||||
Setup concrete module to be enlarged with numpy module.
|
||||
"""
|
||||
|
||||
# Do not modify, this is to have a compatible namespace package
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
"""
|
||||
Declaration of `concrete.numpy` namespace.
|
||||
Export everything that users might need.
|
||||
"""
|
||||
|
||||
from .compilation import (
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
"""
|
||||
Declaration of `concrete.numpy.compilation` namespace.
|
||||
Glue the compilation process together.
|
||||
"""
|
||||
|
||||
from .artifacts import CompilationArtifacts
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
"""
|
||||
Declaration of `concrete.numpy.dtypes` namespace.
|
||||
Define available data types and their semantics.
|
||||
"""
|
||||
|
||||
from .base import BaseDataType
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
"""
|
||||
Declaration of `concrete.numpy.extensions` namespace.
|
||||
Provide additional features that are not present in numpy.
|
||||
"""
|
||||
|
||||
from .convolution import conv2d
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
"""
|
||||
Declaration of `concrete.numpy.internal` namespace.
|
||||
Export functions that are used internally by other modules for common things (e.g., assertions).
|
||||
"""
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
"""
|
||||
Declaration of `concrete.numpy.mlir` namespace.
|
||||
Provide `computation graph` to `mlir` functionality.
|
||||
"""
|
||||
|
||||
from .graph_converter import GraphConverter
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
"""
|
||||
Declaration of `concrete.numpy.representation` namespace.
|
||||
Define structures used to represent computation.
|
||||
"""
|
||||
|
||||
from .graph import Graph
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
"""
|
||||
Declaration of `concrete.numpy.tracing` namespace.
|
||||
Provide `function` to `computation graph` functionality.
|
||||
"""
|
||||
|
||||
from .tracer import Tracer
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
"""
|
||||
Declaration of `concrete.numpy.values` namespace.
|
||||
Define the available values and their semantics.
|
||||
"""
|
||||
|
||||
from .scalar import ClearScalar, EncryptedScalar
|
||||
|
||||
Reference in New Issue
Block a user