From affb9010d0814eaab183fe8f23546486f428175b Mon Sep 17 00:00:00 2001 From: Antonios Sarikas Date: Fri, 3 Jan 2025 00:18:04 +0200 Subject: [PATCH] docs: populate changelog for new version Fixes #18 --- docs/source/changelog.rst | 31 ++++++++++++++++++++++++++++--- docs/source/conf.py | 3 +++ src/aidsorb/litmodels.py | 2 +- src/aidsorb/modules.py | 3 +-- 4 files changed, 33 insertions(+), 6 deletions(-) diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index a48f09b..efc8c3c 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -1,13 +1,38 @@ :octicon:`log` Changelog ======================== -Version 1.1.0 +Version 2.0.0 ------------- -.. versionchanged:: 1.1.0 +.. versionadded:: 2.0.0 + + * Support to ``.load_from_checkpoint`` without arguments for + :class:`~.PCDLit` and :class:`~.PCDDataModule`. + * Support for unlabeled data in :class:`~.PCDDataset` and + :class:`~.Collator`. + * Option ``drop_last`` for :class:`~.PCDDataModule`. + * :class:`~.PCDLit` which supports customization for optimizer and + scheduler (:issue:`25`). + * :func:`~.center_pcd` as a functional interface of :class:`~.Center`. - * The ``split_pcd`` function moved from :mod:`aidsorb.utils` to :mod:`aidsorb.transforms`. +.. versionchanged:: 2.0.0 + * :func:`~.get_names` returns tuple. + * Bumped Lightning version to ``>=2.5.0`` (:issue:`29`). + * :func:`~.upsample_pcd` moved from :mod:`~aidsorb.data` to :mod:`~aidsorb.transforms`. + * :func:`~.split_pcd` moved from :mod:`~aidsorb.utils` to + :mod:`~aidsorb.transforms` and *no longer copies data*. + * :mod:`~.transforms` use :mod:`torch` instead of :mod:`numpy` (:issue:`32`). + * Remove defaults for :class:`~.Jitter` and :class:`~.RandomErase`, + since there is no consensus on "good" defaults. + * Point clouds are stored as plain ``.npy`` files under a directory files + instead of a single ``.npz`` (:issue:`3`). + +.. versionremoved:: 2.0.0 + + * ``PointLit`` in favor of :mod:`~.PCDLit`. + * ``Identity`` from :mod:`~.transforms` since it is equivalent to + :class:`torch.nn.Identity` (and thus redundant). Version 1.0.0 ------------- diff --git a/docs/source/conf.py b/docs/source/conf.py index 6219e5f..d4421cc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -28,6 +28,7 @@ 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary', + 'sphinx.ext.extlinks', 'sphinx_design', 'sphinx_copybutton', 'sphinx_gallery.gen_gallery', @@ -59,6 +60,8 @@ 'plotly': ('https://plotly.com/python-api-reference/', None), } +extlinks = {'issue': ('https://github.com/adosar/aidsorb/issues/%s', '#%s')} + # For commonly used links and inline text. rst_epilog = ''' .. |pytorch| replace:: :bdg-link-primary:`PyTorch ` diff --git a/src/aidsorb/litmodels.py b/src/aidsorb/litmodels.py index ec3dccd..e634e24 100644 --- a/src/aidsorb/litmodels.py +++ b/src/aidsorb/litmodels.py @@ -59,7 +59,7 @@ class PCDLit(L.LightningModule): used. * ``'name'`` optimizer's class name :class:`str` - * ``'hparams'`` scheduler's hyperparameters :class:`dict` + * ``'hparams'`` optimizer's hyperparameters :class:`dict` config_scheduler : dict, optional Dictionary for configuring learning rate scheduler. diff --git a/src/aidsorb/modules.py b/src/aidsorb/modules.py index 88feb8d..00f4b82 100644 --- a/src/aidsorb/modules.py +++ b/src/aidsorb/modules.py @@ -273,8 +273,7 @@ def forward(self, x): Returns ------- out : tuple of length 2 - * ``out[0] == features`` - * ``out[1] == critical_indices`` + Output in the form ``(features, critical_indices)``. """ n_points = x.shape[2]