Update the documentation to API format, describing only the public methods.#57
Merged
Joao-Paulo-Silva merged 60 commits intoAIS-Package:developfrom Apr 21, 2026
Merged
Conversation
Joao-Paulo-Silva
added
documentation
…rrors in Docusaurus
…d predict functions.
Joao-Paulo-Silva
force-pushed
the
refactor/docs
branch
from
2e2b1b6 to
ff88e01
Compare
Joao-Paulo-Silva
added a commit
that referenced
this pull request
Apr 21, 2026
Merged
Joao-Paulo-Silva
added a commit
that referenced
this pull request
Apr 21, 2026
This release (v0.5.4) brings together critical improvements, bug fixes, and documentation updates, with a focus on compatibility, consistency, and API quality. ## Changes - Improved compatibility with scikit-learn (#60) - Added explicit p parameter to the constructor, replacing the use of kwargs - Updated the base class get_params() method to automatically retrieve valid parameters - Fixed a critical issue where no_label_sample_selection always assigned the default value (#61) - Removed redundant table header validation in the ProgressTable class - Standardized docstrings following the API format (#57) - Documentation now focuses exclusively on public methods - Added documentation templates for classes, functions, and modules - Improved overall consistency and clarity of parameter descriptions --------- Co-authored-by: Himel Das <151542219+himelds@users.noreply.github.com>
Joao-Paulo-Silva
added a commit
to AIS-Package/ais-package.github.io
that referenced
this pull request
Apr 26, 2026
Updates the documentation to reflect the changes introduced by the new AISP documentation in [PR #57](AIS-Package/aisp#57).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request updates the documentation across the AISP package to follow a standardized API format, focusing on describing only public methods and improving consistency with best practices.
Changes
Checklist