docs: improve module docstrings

This commit is contained in:
Umut
2022-04-04 16:14:55 +02:00
parent 036e127b05
commit fdd3efa2ce
10 changed files with 10 additions and 10 deletions

View File

@@ -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

View File

@@ -1,5 +1,5 @@
"""
Declaration of `concrete.numpy` namespace.
Export everything that users might need.
"""
from .compilation import (

View File

@@ -1,5 +1,5 @@
"""
Declaration of `concrete.numpy.compilation` namespace.
Glue the compilation process together.
"""
from .artifacts import CompilationArtifacts

View File

@@ -1,5 +1,5 @@
"""
Declaration of `concrete.numpy.dtypes` namespace.
Define available data types and their semantics.
"""
from .base import BaseDataType

View File

@@ -1,5 +1,5 @@
"""
Declaration of `concrete.numpy.extensions` namespace.
Provide additional features that are not present in numpy.
"""
from .convolution import conv2d

View File

@@ -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).
"""

View File

@@ -1,5 +1,5 @@
"""
Declaration of `concrete.numpy.mlir` namespace.
Provide `computation graph` to `mlir` functionality.
"""
from .graph_converter import GraphConverter

View File

@@ -1,5 +1,5 @@
"""
Declaration of `concrete.numpy.representation` namespace.
Define structures used to represent computation.
"""
from .graph import Graph

View File

@@ -1,5 +1,5 @@
"""
Declaration of `concrete.numpy.tracing` namespace.
Provide `function` to `computation graph` functionality.
"""
from .tracer import Tracer

View File

@@ -1,5 +1,5 @@
"""
Declaration of `concrete.numpy.values` namespace.
Define the available values and their semantics.
"""
from .scalar import ClearScalar, EncryptedScalar