Skip to content

Improved directed search tutorial#194

Merged
quaquel merged 23 commits intomasterfrom
doc_ro
Oct 25, 2022
Merged

Improved directed search tutorial#194
quaquel merged 23 commits intomasterfrom
doc_ro

Conversation

@quaquel
Copy link
Copy Markdown
Owner

@quaquel quaquel commented Oct 13, 2022

Building on #193, this substantially expand the directed search tutorial with improved discusion on convergence, seed analysis and robust optimization. In addition various links to relevant literature has been added.

This pull request has already been rebased on #193, so first we need to merge that one before we review this one.

@quaquel quaquel requested a review from EwoutH October 13, 2022 04:58
@quaquel quaquel added this to the 2.3.0 milestone Oct 13, 2022
@quaquel quaquel added the docs label Oct 13, 2022
@coveralls
Copy link
Copy Markdown

coveralls commented Oct 13, 2022

Coverage Status

Coverage remained the same at 81.139% when pulling 31fb573 on doc_ro into 54ba5e6 on master.

@EwoutH
Copy link
Copy Markdown
Collaborator

EwoutH commented Oct 13, 2022

Could you enable Review NB on this repository? That would make reviewing the Jupyter Notebooks a lot easier.

You can install it at GitHub Marketplace. The "Free" option for open source works, and you only have to give it access to this specific repository.

It will also be useful once I will take a look at the example.

Copy link
Copy Markdown
Collaborator

@EwoutH EwoutH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First review round, it looks good in general! I tried to be quite thorough in the review, let me know what you think of it.

@quaquel
Copy link
Copy Markdown
Owner Author

quaquel commented Oct 13, 2022

Could you enable Review NB on this repository? That would make reviewing the Jupyter Notebooks a lot easier.

You can install it at GitHub Marketplace. The "Free" option for open source works, and you only have to give it access to this specific repository.

It will also be useful once I will take a look at the example.

Should be done now.

@review-notebook-app
Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@EwoutH
Copy link
Copy Markdown
Collaborator

EwoutH commented Oct 13, 2022

Awesome, I will try to review the notebook tomorrow!

@quaquel
Copy link
Copy Markdown
Owner Author

quaquel commented Oct 14, 2022

Thanks for the review so far. See my responses. All other issues have been resolved.\

One minor thing: all modifications to optimization.py are part of #193. So once you agree with the responses here, I'll move those changes back into that branch and rebase this one. This branch then should only contain the updated notebook, once #193 has been merged.

@@ -98,9 +98,9 @@
"name": "stderr",
Copy link
Copy Markdown
Collaborator

@EwoutH EwoutH Oct 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where we are going to search over the levers for solutions that have robust performance over a set of scenarios.

Explain/define robust performance briefly and link to further resources.

specify our robustness metrics.

Which robustness metrics are in the workbench? List, link to overview and/or link to each metric.


Reply via ReviewNB

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no robustness metrics in the workbench. Robustness if further specified in mcphail to which I already link.

@@ -98,9 +98,9 @@
"name": "stderr",
Copy link
Copy Markdown
Collaborator

@EwoutH EwoutH Oct 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

robsut --> robust

What we can see in this parallel axis plot is that there is a clear tradeoff between robustly high reliability and robsut low maximum polution

Add how this can be seen (probably diagonal lines, or high density of lines on opposites of the Y-axis between variables)

Aside from only plotting, can we also express these metrics numerically?

Finally, a summary of what is and can be done in this whole notebook needs to be added, with some links and resources where to go further.


Reply via ReviewNB

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. there is a dataframe so yes we have numbers
  2. no idea what you have in mind and whether it belongs in the documentation.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let’s discuss this in person

@EwoutH
Copy link
Copy Markdown
Collaborator

EwoutH commented Oct 18, 2022

all modifications to optimization.py are part of #193. So once you agree with the responses here, I'll move those changes back into that branch and rebase this one.

Yes that's perfect, I probably should have reviewed those changes in #193, I didn't see they were largely overlapping, sorry for that.

If you move the changes in #193 I will do a final review on that.

I've reviewed the notebook, see https://app.reviewnb.com/quaquel/EMAworkbench/pull/194/files/

@quaquel
Copy link
Copy Markdown
Owner Author

quaquel commented Oct 19, 2022

From my perspective all comments on optimization.py are resolved. There are a few points for further discussion outstanding in the notebook.

@EwoutH
Copy link
Copy Markdown
Collaborator

EwoutH commented Oct 19, 2022

Perfect, if you port them to #193 I will give it a last look and merge it!

@quaquel
Copy link
Copy Markdown
Owner Author

quaquel commented Oct 19, 2022

Perfect, if you port them to #193 I will give it a last look and merge it!

I have committed the final version of optimization.py to #193.

@quaquel
Copy link
Copy Markdown
Owner Author

quaquel commented Oct 20, 2022

Now that #193 has been merged, we can finalize this as well. There are a view outstanding issues in the notebook. Do you want to go through those in person, or do you prefer to reply in reviewNB?

@EwoutH
Copy link
Copy Markdown
Collaborator

EwoutH commented Oct 23, 2022

Most of it looks good, there are two things let I want to discuss in person.

would you be able to rebase and clean up before out meeting? Then we can probably merge during it.

@EwoutH EwoutH self-requested a review October 25, 2022 10:01
@quaquel quaquel merged commit 76dcc45 into master Oct 25, 2022
@quaquel quaquel deleted the doc_ro branch October 25, 2022 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants