Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ argument to :class:`~dpsynth.TabularConfig`.
:nosignatures:
:template: autosummary/class.rst

Schema
CategoricalAttribute
NumericalAttribute
OpenSetCategoricalAttribute
Expand Down
15 changes: 14 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,22 @@
'show-inheritance': True,
}

# templates_path = ['_templates']
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

root_doc = 'index'
master_doc = 'index'

autodoc_mock_imports = [
'pipeline_dp',
'apache_beam',
'tensorflow',
'flax',
'gemma',
'jax_privacy',
'optax',
]

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

Expand Down
3 changes: 3 additions & 0 deletions docs/in_memory_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ When initializing `dpsynth.TabularConfig`:
partition selection (default: `0.1`).
* `cross_attribute_constraints`: Optional sequence of constraints to enforce
on generated data.
* `compress_columns`: Whether to compress rare categories (< 3*sigma) for
`CategoricalAttribute` columns not present in constraints
(default: `False`).

When calling `config.calibrate(...)`:

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ APIs:

data_and_terminology
in_memory_api
scalable_pipeline_api
scalable_beam_api
```

```{toctree}
Expand Down
3 changes: 2 additions & 1 deletion docs/processing_lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ floating-point ranges, unbounded string categories, high-dimensional state
spaces, and strict privacy budget accounting.

This page details the 5-stage mathematical lifecycle executed across both the
[In-Memory](in_memory_api.md) and [Scalable Pipeline](scalable_beam_api.md)
[In-Memory](in_memory_api.md) and
[Scalable Pipeline](scalable_beam_api.md)
APIs.

```
Expand Down
Loading