From 080307b151482672da88ffb1023cbf3a5d88d24c Mon Sep 17 00:00:00 2001 From: Julien Girard <julien.girard2@cea.fr> Date: Wed, 19 Jun 2024 10:21:03 +0200 Subject: [PATCH] [doc] Updated doc to match 2.0 release --- doc/conf.py | 6 +++--- doc/contributing.rst | 1 + doc/index.rst | 7 ++++--- doc/interpretation.rst | 8 ++++---- 4 files changed, 12 insertions(+), 10 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 2e45e7b..e7f85be 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -21,7 +21,7 @@ sys.path.append(os.path.abspath('./ext')) # -- Project information ----------------------------------------------------- project = 'CAISAR' -copyright = '2023, The CAISAR Development Team' +copyright = '2024, The CAISAR Development Team' author = 'The CAISAR Development Team' # The version info for the project you're documenting, acts as replacement for @@ -29,9 +29,9 @@ author = 'The CAISAR Development Team' # built documents. # # The short X.Y version. -version = '1.0' +version = '2.0' # The full version, including alpha/beta/rc tags. -release = '1.0' +release = '2.0' # -- General configuration --------------------------------------------------- diff --git a/doc/contributing.rst b/doc/contributing.rst index cc1d17a..76d8393 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -27,6 +27,7 @@ The root of the repository has the following folders: * ``stdlib/`` contains WhyML files used to define theories for the CAISAR interpreted language. * ``tests/`` are non-regression tests written in `dune cram test syntax <https://dune.readthedocs.io/en/stable/tests.html>`_. +* ``utils/`` are helper functions used internally by CAISAR (for instance, logging utilities). Setting up a development environment diff --git a/doc/index.rst b/doc/index.rst index 6ccf4ea..00bcd02 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -18,12 +18,13 @@ The CAISAR Platform François Bobot, Julien Girard -:Version: |version|, December 2023 -:Copyright: 2020--2023 CEA (Commissariat à l'énergie atomique et aux énergies alternatives) +:Version: |version|, June 2024 +:Copyright: 2020--2024 CEA (Commissariat à l'énergie atomique et aux énergies alternatives) .. _Confiance.ai: https://www.confiance.ai/ +.. _DeepGreen: https://www.deepgreen.ai/ -This work has been partly supported by the `Confiance.ai`_ program. +This work has been partly supported by the `Confiance.ai`_ program and the `DeepGreen`_ project. .. toctree:: :maxdepth: 2 diff --git a/doc/interpretation.rst b/doc/interpretation.rst index f484ad3..b87e9b1 100644 --- a/doc/interpretation.rst +++ b/doc/interpretation.rst @@ -109,12 +109,12 @@ Functions .. code-block:: whyml - (** Returns a symbol for the neural network with filename n. **) - function read_model (n: string) : model nn + (** Returns a symbol for the machine learning model with filename n. **) + function read_model (n: string) : model - (** Returns a vector that represents the application of neural network + (** Returns a vector that represents the application of a model on an input vector. **) - function (@@) (n: model nn) (v: vector 'a) : vector 'a + function (@@) (n: model) (v: vector 'a) : vector 'a Dataset ******* -- GitLab