Skip to content

Commit

Permalink
updated workflow. fixed deprecated warning in doc build
Browse files Browse the repository at this point in the history
  • Loading branch information
quattro committed Mar 26, 2024
1 parent 234c4d8 commit e619abd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
1 change: 0 additions & 1 deletion .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ jobs:
- name: Upload docs
uses: actions/upload-artifact@v4
with:
name: docs
path: site # where `mkdocs build` puts the built site

- name: Deploy to GitHub Pages
Expand Down
8 changes: 4 additions & 4 deletions src/traceax/_estimators.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def _get_shape(operator: AbstractLinearOperator) -> int:


class AbstractTraceEstimator(eqx.Module, strict=True):
"""Abstract base class for all trace estimators."""
r"""Abstract base class for all trace estimators."""

sampler: AbstractVar[AbstractSampler]

Expand All @@ -48,7 +48,7 @@ def __call__(self, key: PRNGKeyArray, operator: AbstractLinearOperator, k: int)


class HutchinsonEstimator(AbstractTraceEstimator):
"""Girard-Hutchinson Trace Estimator:
r"""Girard-Hutchinson Trace Estimator:
$\mathbb{E}[\omega^T \mathbf{A} \omega] = \\text{trace}(\mathbf{A})$,
where $\mathbb{E}[\omega] = 0$ and $\mathbb{E}[\omega \omega^T] = \mathbf{I}$.
Expand Down Expand Up @@ -81,7 +81,7 @@ def compute(self, key: PRNGKeyArray, operator: AbstractLinearOperator, k: int) -


class HutchPlusPlusEstimator(AbstractTraceEstimator):
"""Hutch++ Trace Estimator:
r"""Hutch++ Trace Estimator:
Let $\hat{\mathbf{A}} := \mathbf{Q}\mathbf{Q}^* \mathbf{A}$ be the the _low-rank approximation_
to $\mathbf{A}$, where $\mathbf{Q}$ is the orthonormal basis of $\mathbf{A} \Omega$, for
Expand Down Expand Up @@ -133,7 +133,7 @@ def compute(self, key: PRNGKeyArray, operator: AbstractLinearOperator, k: int) -


class XTraceEstimator(AbstractTraceEstimator):
""" """
r""" """

sampler: AbstractSampler = SphereSampler()
rescale: bool = True
Expand Down

0 comments on commit e619abd

Please sign in to comment.