Skip to content

Update Documentation  #20

Description

@agzieba

Summary

  • Update and expand the documentation to cover newly introduced features in the codebase more comprehensively.
  • Provide additional details about the uncertainty quantification (UQ) methods utilized by each estimator, specifying approaches, assumptions, and use cases where possible.
  • Review and update all tutorial notebooks to ensure they are fully compatible with the most recent version of the codebase.

Tasks

  • Identify and document all novel features introduced since the last major documentation update.
  • For each estimator, detail the UQ methodology leveraged, referencing implementation details as needed.
  • Verify all tutorial notebooks execute successfully with the latest codebase and update them where required.
  • Add or improve examples that illustrate novel features and UQ integrations.
  • Ensure consistency, clarity, and completeness across the updated documentation and notebooks.

Motivation
Comprehensive, up-to-date documentation and tutorials are essential for users and contributors to fully leverage new features and UQ capabilities.

Acceptance Criteria

  • All novel features are documented and discoverable.
  • UQ methods are explained at the estimator level.
  • All notebooks run without errors and reflect the latest API/procedures.
  • Documentation is clear, consistent, and actionable.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions