Skip to content

Commit

Permalink
docs: populate changelog for new version
Browse files Browse the repository at this point in the history
Fixes #18
  • Loading branch information
adosar committed Jan 2, 2025
1 parent 0f7918a commit affb901
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 6 deletions.
31 changes: 28 additions & 3 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -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
-------------
Expand Down
3 changes: 3 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'sphinx.ext.autosummary',
'sphinx.ext.extlinks',
'sphinx_design',
'sphinx_copybutton',
'sphinx_gallery.gen_gallery',
Expand Down Expand Up @@ -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 <https://pytorch.org/>`
Expand Down
2 changes: 1 addition & 1 deletion src/aidsorb/litmodels.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions src/aidsorb/modules.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down

0 comments on commit affb901

Please sign in to comment.