Skip to content

Documentation loads from dev version #36

@wereinwild

Description

@wereinwild

Hello,

Thank you, Deron and US-EPA, for developing this fantastic tool. The obsolete PMF5 was clunky.

Issue: All documentation on GitHub is being built from the development version, currently 2025.0.2, while the latest PyPI deployment version is still 2025.0.1. This creates many discrepancies between the examples in the workflow notebook and actual usage.

Examples:

  • Most constructors and methods don't have the same signatures as what is seen on branch main on GitHub.
  • Documentation shows classes SA and BatchSA have an attribute use_gpu, and in deployment, they don't (BTW, can you add a logger message if CUDA was used? 'Parallel' is not the same, IIUC).
  • Documentation shows usage of ModelAnalysis.plot_residual_histogram() as having two arguments, while only one is used.
  • ModelAnalysis.plot_factor_contributions(feature_idx=0) returns error 'NoneType' object has no attribute 'shape' (while other plotting functions work).

– etc.

One workaround could be to build branch dev from source, but the documentation should pertain to production. Or, is building from source, the recommended way to use esat at this time?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions