Skip to content

Conversation

@xaviernogueira
Copy link
Contributor

@xaviernogueira xaviernogueira commented Oct 10, 2023

Closes #21

Changes:

  • I updated the model_architecture.ipynb notebook to step by step walk-thru building a simple model. Only after everything is explained do I show the real-world TSM example.
  • I also made a very minor change in utils.py to fix a bug.
  • I made a new class method for base.Model -> base.Model.get_state_variables() that allows state variables to be seen before the model is initialized. This allows one to see which variables need to be put in the input dictionary without digging thru the code.

@aufdenkampe mind commenting on the notebook before I merge? (edit: whoops, couldn't revert, still would appreciate comments I can add)

@xaviernogueira xaviernogueira added the documentation Improvements or additions to documentation label Oct 10, 2023
@xaviernogueira xaviernogueira linked an issue Oct 10, 2023 that may be closed by this pull request
@xaviernogueira xaviernogueira merged commit 09958fd into main Oct 10, 2023
@xaviernogueira xaviernogueira deleted the 21-make-a-better-demo-of-the-new-architecture-jupyter-notebook branch October 10, 2023 21:16
@aufdenkampe
Copy link
Member

aufdenkampe commented Oct 11, 2023

@xaviernogueira, thanks for these updates! I'm sure @kewalak, @imscw95, @sjordan29 and others will appreciate the clearer guidance.

I'm glad to see that you implemented a base.Model.get_state_variables() method, as this function is required by BMI, which we'll be implementing before too long.

I'll try to review the notebook soon.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make a better demo of the new architecture (jupyter notebook)

3 participants