Skip to content

WIP, DOC: draft release notes (0.1.0) #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tylerjereddy wants to merge 3 commits into
base: main
Choose a base branch
from
+70 −0
Open

WIP, DOC: draft release notes (0.1.0) #37

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fc4221
WIP, DOC: draft release notes (0.1.0)
tylerjereddy Jan 31, 2026
4108f0f
DOCS: Add api links within release note. Add notes to toctree.
nray Feb 3, 2026
80a26ee
Merge branch 'main' into treddy_add_relnotes_0.1.0
nray Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/source/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
*************
Release Notes
*************

This is the list of changes to GFDL between each release.

.. toctree::
:maxdepth: 1

release/0.1.0-notes
Copy link
Collaborator Author

@tylerjereddy tylerjereddy Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

currently renders like this after make html:

Image

Copy link
Collaborator

@nray nray Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added to navigation bar.

59 changes: 59 additions & 0 deletions docs/source/release/0.1.0-notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
==========================
GFDL 0.1.0 Release Notes
==========================

.. note:: GFDL 0.1.0 is not released yet!

.. contents::

Gradient free deep learning (GFDL) 0.1.0 is the culmination of 6
months of hard work. This first release contains three new estimators.
Our development attention will now shift to bug-fix releases on the
0.1.x branch, and on adding new features on the main branch.

This release requires Python 3.12-3.14.
Copy link
Collaborator Author

@tylerjereddy tylerjereddy Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

currently renders like this via make html:

Image



**************************
Highlights of this release
**************************

* The new `gfdl.model.GFDLClassifier` is an estimator offering single and
multi-layer random vector functional link (RVFL) and extreme learning
machine (ELM) gradient-free neural networks. A regression equivalent,
`gfdl.model.GFDLRegressor` has also been added.
* The new `gfdl.model.EnsembleGFDLClassifier` offers a connected ensemble
Copy link
Collaborator Author

@tylerjereddy tylerjereddy Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These should render as hyperlinks to estimators but currently do not--not sure why--sample render just shows italic, could use help with that:

Image

Copy link
Collaborator

@nray nray Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They should be linking now.

Copy link
Collaborator Author

@tylerjereddy tylerjereddy Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah very nice, thanks!

of estimators for multi-layer RVFLs that contribute to model output via
soft or hard voting.


************
New features
************


``gfdl.model`` improvements
============================
* Three new estimators that include single and multi layer extreme learning
machines (ELMs) and random vector functional link (RVFL) networks:
`gfdl.model.GFDLClassifier`, `gfdl.model.GFDLRegressor`, and
`gfdl.model.EnsembleGFDLClassifier`.



*******
Authors
*******
Copy link
Collaborator Author

@tylerjereddy tylerjereddy Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be populated automatically by script from gh-18 before the release happens




************************
Issues closed for 0.1.0
************************


************************
Pull requests for 0.1.0
************************
Copy link
Collaborator Author

@tylerjereddy tylerjereddy Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these two lists to be populated automatically by script in gh-17 before release happens



Loading