Skip to content

Implementing the SimpleAutoEncoder JupyterNotebook and class to training.wrapper - #273

Draft
CheickIsmaelD wants to merge 3 commits into
ACCESS-Community-Hub:developfrom
CheickIsmaelD:changes
Draft

Implementing the SimpleAutoEncoder JupyterNotebook and class to training.wrapper#273
CheickIsmaelD wants to merge 3 commits into
ACCESS-Community-Hub:developfrom
CheickIsmaelD:changes

Conversation

@CheickIsmaelD

Copy link
Copy Markdown

Implementations

1: Added the SimpleAutoEncoder.ipynb file providing a detailed explanation on the functionality and usage of the SimpleAutoEncoder class.
2: Added a _simply.py file into the src/pyearthtools/training folder. This folder contains the standalone SimpleAutoEncoder script
3: Altered the init.py file to import the SimpleAutoEncoder class.

Getting Started

  • If there is not an existing issue, raise a new issue
  • In the issue, state that you are intending to work on a contribution. This gives everyone involved the opportunity to discuss the best way forward.

Docstrings

  • Docstrings complete and follow Napoleon (google) style

Test Coverage

  • [X ] All new code is covered by unit tests
    Two data pipelines were used to determine whether or not the SimpleAutoencoder class was functioning. Would benefit from more test coverage.

Documentation

  • Documentation is updated as required

Final Checks:

  • If no generative AI was used, then tick this box

Alternatively, if generative AI was used, then confirm you have:

  • [X ] Attributed any generative AI (such as GitHub Copilot) that was used in this PR. See our contributing guide for more information.
  • [X ] Included the name and version of the tool or system in the pull request
  • [X ] Described the scope of that use

Claude Sonnet 5 was used to transform the SimpleAutoEncoder Jupyter notebook into a proper Python script, generate the plotting function included in the notebook, check grammar and improve the flow of the notebook's descriptions, and improve abstraction by extracting a run_epoch method to support the fit function (previously, run_epoch's functionality was embedded directly in fit).

Finally,

  • Mark the PR as ready to review. Note - we encourage you to ask for feedback at the outset or at any time during the work.

This is a standalone export of the SimpleAutoEncoder class, kept separate from the JupyterNotebook tutorials to allow for a seamless pull request.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant