Skip to content

Commit 9f0dca6

Browse files
committed
[ci skip] Merge pull request #64 from vyron-arvanitis/release/pypi-sklearn-contrib-bde
Release/pypi sklearn contrib bde cddb7e9
1 parent f37763e commit 9f0dca6

21 files changed

Lines changed: 122 additions & 106 deletions

.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 7f781be20d93321a967a6a433c5c9a70
3+
config: 52d56eefd4959465593413c66c782927
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.

_sources/index.rst.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. bde documentation master file, created by
1+
.. bde documentation master file, created by
22
sphinx-quickstart on Mon Jan 18 14:44:12 2016.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
@@ -12,12 +12,10 @@ Bayesian Deep Ensembles via MILE: easy to use, scikit-learn compatible and fast
1212
**Date**: |today| **Version**: |version|
1313

1414
**Useful links**:
15-
`Source Repository <https://github.com/vyron-arvanitis/bde.git>`__
15+
`Source Repository <https://github.com/scikit-learn-contrib/bde.git>`__ |
16+
`Issues & Ideas <https://github.com/scikit-learn-contrib/bdek/issues>`__
1617

17-
.. `Source Repository <https://github.com/scikit-learn-contrib/bde>`__ |
18-
.. `Issues & Ideas <https://github.com/scikit-learn-contrib/bdek/issues>`__ |
19-
20-
This is the documentation for the `bde`.
18+
This is the documentation for the `bde` package.
2119

2220

2321

_sources/quick_start.rst.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _quick_start:
1+
.. _quick_start:
22

33
###############
44
Quick start
@@ -11,12 +11,17 @@ installing the package, setting up the environment and information regarding JAX
1111
Installation
1212
============
1313

14-
The package will be published on PyPI soon. Until then you can install the
15-
current source build:
14+
To install the latest release from PyPI, run:
1615

1716
.. prompt:: bash $
1817

19-
pip install git+https://github.com/vyron-arvanitis/bde.git
18+
pip install sklearn-contrib-bde
19+
20+
To install the latest development version from GitHub, run:
21+
22+
.. prompt:: bash $
23+
24+
pip install git+https://github.com/scikit-learn-contrib/bde.git
2025

2126
If you prefer reproducible environments with GPU or multi-device CPU support,
2227
consider using `pixi <https://prefix.dev/docs/pixi/overview>`__ as described in

_sources/user_guide.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ The method is particularly well-suited for the complex, multi-modal posteriors
3232
encountered in neural networks and can be implemented embarrassingly parallel across
3333
multiple devices.
3434

35+
Note that this package currently supports fully connected feedforward networks only and
36+
is targeted at tabular data tasks. The method can however also be applied to other
37+
architectures and data modalities, but these are not yet in the scope of this
38+
particular implementation. Further the full package acts in the full-batch setting
39+
only; stochastic mini-batching is not supported at this time.
40+
3541
For references and theoretical as well as algorithmic details, see
3642
`Microcanonical Langevin Ensembles: Advancing the Sampling of Bayesian Neural Networks (ICLR 2025) <https://arxiv.org/abs/2502.06335>`_.
3743

_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '0.1.dev339+g14caffd3e',
2+
VERSION: '1.0.1.dev7+gcddb7e916',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

api.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta charset="utf-8" />
99
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1010

11-
<title>API Reference &#8212; bde 0.1.dev339+g14caffd3e documentation</title>
11+
<title>API Reference &#8212; bde 1.0.1.dev7+gcddb7e916 documentation</title>
1212

1313

1414

@@ -42,7 +42,7 @@
4242
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
4343
<script src="_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
4444

45-
<script src="_static/documentation_options.js?v=0726b844"></script>
45+
<script src="_static/documentation_options.js?v=19d36b63"></script>
4646
<script src="_static/doctools.js?v=9a2dae69"></script>
4747
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
4848
<script src="_static/design-tabs.js?v=36754332"></script>
@@ -128,8 +128,8 @@
128128

129129

130130

131-
<img src="_static/logo.svg" class="logo__image only-light" alt="bde 0.1.dev339+g14caffd3e documentation - Home"/>
132-
<script>document.write(`<img src="_static/logo.svg" class="logo__image only-dark" alt="bde 0.1.dev339+g14caffd3e documentation - Home"/>`);</script>
131+
<img src="_static/logo.svg" class="logo__image only-light" alt="bde 1.0.1.dev7+gcddb7e916 documentation - Home"/>
132+
<script>document.write(`<img src="_static/logo.svg" class="logo__image only-dark" alt="bde 1.0.1.dev7+gcddb7e916 documentation - Home"/>`);</script>
133133

134134

135135
</a></div>
@@ -217,7 +217,7 @@
217217

218218

219219

220-
<a href="https://github.com/vyron-arvanitis/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
220+
<a href="https://github.com/scikit-learn-contrib/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
221221
<span class="sr-only">GitHub</span></a>
222222
</li>
223223
</ul></div>
@@ -328,7 +328,7 @@
328328

329329

330330

331-
<a href="https://github.com/vyron-arvanitis/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
331+
<a href="https://github.com/scikit-learn-contrib/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
332332
<span class="sr-only">GitHub</span></a>
333333
</li>
334334
</ul></div>
@@ -472,7 +472,7 @@ <h2>Estimators<a class="headerlink" href="#estimators" title="Link to this headi
472472

473473

474474
<div class="tocsection editthispage">
475-
<a href="https://github.com/vyron-arvanitis/bde/edit/main/doc/api.rst">
475+
<a href="https://github.com/scikit-learn-contrib/bde/edit/main/doc/api.rst">
476476
<i class="fa-solid fa-pencil"></i>
477477

478478

auto_examples/example.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta charset="utf-8" />
99
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1010

11-
<title>Usage Examples &#8212; bde 0.1.dev339+g14caffd3e documentation</title>
11+
<title>Usage Examples &#8212; bde 1.0.1.dev7+gcddb7e916 documentation</title>
1212

1313

1414

@@ -42,7 +42,7 @@
4242
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
4343
<script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
4444

45-
<script src="../_static/documentation_options.js?v=0726b844"></script>
45+
<script src="../_static/documentation_options.js?v=19d36b63"></script>
4646
<script src="../_static/doctools.js?v=9a2dae69"></script>
4747
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
4848
<script src="../_static/design-tabs.js?v=36754332"></script>
@@ -126,8 +126,8 @@
126126

127127

128128

129-
<img src="../_static/logo.svg" class="logo__image only-light" alt="bde 0.1.dev339+g14caffd3e documentation - Home"/>
130-
<script>document.write(`<img src="../_static/logo.svg" class="logo__image only-dark" alt="bde 0.1.dev339+g14caffd3e documentation - Home"/>`);</script>
129+
<img src="../_static/logo.svg" class="logo__image only-light" alt="bde 1.0.1.dev7+gcddb7e916 documentation - Home"/>
130+
<script>document.write(`<img src="../_static/logo.svg" class="logo__image only-dark" alt="bde 1.0.1.dev7+gcddb7e916 documentation - Home"/>`);</script>
131131

132132

133133
</a></div>
@@ -215,7 +215,7 @@
215215

216216

217217

218-
<a href="https://github.com/vyron-arvanitis/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
218+
<a href="https://github.com/scikit-learn-contrib/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
219219
<span class="sr-only">GitHub</span></a>
220220
</li>
221221
</ul></div>
@@ -326,7 +326,7 @@
326326

327327

328328

329-
<a href="https://github.com/vyron-arvanitis/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
329+
<a href="https://github.com/scikit-learn-contrib/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
330330
<span class="sr-only">GitHub</span></a>
331331
</li>
332332
</ul></div>
@@ -740,7 +740,7 @@
740740

741741

742742
<div class="tocsection editthispage">
743-
<a href="https://github.com/vyron-arvanitis/bde/edit/main/doc/auto_examples/example.rst">
743+
<a href="https://github.com/scikit-learn-contrib/bde/edit/main/doc/auto_examples/example.rst">
744744
<i class="fa-solid fa-pencil"></i>
745745

746746

auto_examples/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta charset="utf-8" />
99
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1010

11-
<title>Examples &#8212; bde 0.1.dev339+g14caffd3e documentation</title>
11+
<title>Examples &#8212; bde 1.0.1.dev7+gcddb7e916 documentation</title>
1212

1313

1414

@@ -42,7 +42,7 @@
4242
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
4343
<script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
4444

45-
<script src="../_static/documentation_options.js?v=0726b844"></script>
45+
<script src="../_static/documentation_options.js?v=19d36b63"></script>
4646
<script src="../_static/doctools.js?v=9a2dae69"></script>
4747
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
4848
<script src="../_static/design-tabs.js?v=36754332"></script>
@@ -127,8 +127,8 @@
127127

128128

129129

130-
<img src="../_static/logo.svg" class="logo__image only-light" alt="bde 0.1.dev339+g14caffd3e documentation - Home"/>
131-
<script>document.write(`<img src="../_static/logo.svg" class="logo__image only-dark" alt="bde 0.1.dev339+g14caffd3e documentation - Home"/>`);</script>
130+
<img src="../_static/logo.svg" class="logo__image only-light" alt="bde 1.0.1.dev7+gcddb7e916 documentation - Home"/>
131+
<script>document.write(`<img src="../_static/logo.svg" class="logo__image only-dark" alt="bde 1.0.1.dev7+gcddb7e916 documentation - Home"/>`);</script>
132132

133133

134134
</a></div>
@@ -216,7 +216,7 @@
216216

217217

218218

219-
<a href="https://github.com/vyron-arvanitis/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
219+
<a href="https://github.com/scikit-learn-contrib/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
220220
<span class="sr-only">GitHub</span></a>
221221
</li>
222222
</ul></div>
@@ -327,7 +327,7 @@
327327

328328

329329

330-
<a href="https://github.com/vyron-arvanitis/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
330+
<a href="https://github.com/scikit-learn-contrib/bde" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
331331
<span class="sr-only">GitHub</span></a>
332332
</li>
333333
</ul></div>
@@ -446,7 +446,7 @@ <h1>Examples<a class="headerlink" href="#examples" title="Link to this heading">
446446

447447

448448
<div class="tocsection editthispage">
449-
<a href="https://github.com/vyron-arvanitis/bde/edit/main/doc/auto_examples/index.rst">
449+
<a href="https://github.com/scikit-learn-contrib/bde/edit/main/doc/auto_examples/index.rst">
450450
<i class="fa-solid fa-pencil"></i>
451451

452452

0 commit comments

Comments
 (0)