Skip to content

Commit

Permalink
Update README, doc homepage warning
Browse files Browse the repository at this point in the history
  • Loading branch information
WardBrian committed Apr 26, 2024
1 parent eac3d4e commit 684b924
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TinyStan

**Note**: This project is still under active development. The API is not yet stable, and the documentation is incomplete. Using before a 1.0 release is not recommended for most users.
> [!WARNING]
> This project is still under active development. The API is not yet stable, and the documentation is incomplete. Using before a 1.0 release is not recommended for most users.
**TinyStan** is a library that provides a C interface to the [Stan](https://mc-stan.org) algorithms, such as sampling with the No-U-Turn Sampler (NUTS),
and language bindings in Julia, Python, and R.
Expand Down
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
Welcome to TinyStan's documentation!
====================================

.. warning::
This project is still under active development. The API is not yet stable, and the documentation is incomplete. Using before a 1.0 release is not recommended for most users.

**TinyStan** is a library that provides a C interface to the `Stan <https://mc-stan.org>`_ algorithms, such as sampling with the No-U-Turn Sampler (NUTS),
and language bindings in Julia, Python, and R.

.. toctree::
:maxdepth: 2
:caption: Contents:
Expand Down
14 changes: 7 additions & 7 deletions docs/languages/julia.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Load a Stan model for inference, compiling it if necessary.
If model is a path to a file ending in `.stan`, this will first compile the model. Compilation occurs if no shared object file exists for the supplied Stan file or if a shared object file exists and the Stan file has changed since last compilation. This is equivalent to calling [`compile_model`](julia.md#TinyStan.compile_model) and then the constructor. If `warn` is false, the warning about re-loading the same shared objects is suppressed.


<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L42-L53' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L43-L54' class='documenter-source'>source</a><br>

<a id='TinyStan.sample' href='#TinyStan.sample'>#</a>
**`TinyStan.sample`** &mdash; *Function*.
Expand All @@ -125,7 +125,7 @@ Run Stan's No-U-Turn Sampler (NUTS) to sample from the posterior. An in-depth ex
Returns a tuple of the parameter names, the draws, and the metric if `save_metric` is true.


<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L193-L203' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L169-L179' class='documenter-source'>source</a><br>

<a id='TinyStan.HMCMetric' href='#TinyStan.HMCMetric'>#</a>
**`TinyStan.HMCMetric`** &mdash; *Type*.
Expand All @@ -137,7 +137,7 @@ Choices for the structure of the mass matrix used in the HMC sampler.
Either `UNIT`, `DENSE`, or `DIAGONAL`.


<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L2-L6' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L3-L7' class='documenter-source'>source</a><br>

<a id='TinyStan.pathfinder' href='#TinyStan.pathfinder'>#</a>
**`TinyStan.pathfinder`** &mdash; *Function*.
Expand All @@ -153,7 +153,7 @@ Run the Pathfinder algorithm to approximate the posterior. See [Stan's documenta
Returns a tuple of the parameter names and the draws.


<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L364-L372' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L309-L317' class='documenter-source'>source</a><br>

<a id='TinyStan.optimize' href='#TinyStan.optimize'>#</a>
**`TinyStan.optimize`** &mdash; *Function*.
Expand All @@ -171,7 +171,7 @@ This will find either the maximum a posteriori (MAP) estimate or the maximum lik
Returns a tuple of the parameter names and the optimized values.


<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L490-L501' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L407-L418' class='documenter-source'>source</a><br>

<a id='TinyStan.OptimizationAlgorithm' href='#TinyStan.OptimizationAlgorithm'>#</a>
**`TinyStan.OptimizationAlgorithm`** &mdash; *Type*.
Expand All @@ -183,7 +183,7 @@ Choices for the optimization algorithm to use.
Either `NEWTON`, `BFGS`, or `LBFGS`.


<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L13-L17' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L14-L18' class='documenter-source'>source</a><br>

<a id='TinyStan.laplace_sample' href='#TinyStan.laplace_sample'>#</a>
**`TinyStan.laplace_sample`** &mdash; *Function*.
Expand All @@ -199,7 +199,7 @@ Sample from the Laplace approximation of the posterior centered at the provided
Returns a tuple of the parameter names and the draws.


<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L588-L597' class='documenter-source'>source</a><br>
<a target='_blank' href='https://github.com/WardBrian/TinyStan/blob/main/clients/julia/src/model.jl#L481-L490' class='documenter-source'>source</a><br>


<a id='Compilation-utilities'></a>
Expand Down

0 comments on commit 684b924

Please sign in to comment.