Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation with tools api #55

Merged
merged 7 commits into from
Jul 20, 2021

Conversation

geoffreyp
Copy link
Contributor

No description provided.

@geoffreyp geoffreyp linked an issue Mar 31, 2021 that may be closed by this pull request
docs/tuto.rst Outdated
if moead.current_eval % 10 ==0 :
filename = "non_dominated_solutions-eval" + str(moead.current_eval) + ".txt"
save_population(file_name=filename, population=moead.ep)
def checkpoint(moead_algorithm: AbstractMoead)::
Copy link
Contributor

Choose a reason for hiding this comment

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

Double colon :: should be a single one

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed in the commit c3fce1e


moead.run(checkpoint=checkpt)
moead.run(checkpoint=checkpoint)
Copy link
Contributor

Choose a reason for hiding this comment

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

The same change should be made in the next code block (line 149)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed in the commit c3fce1e

.. autosummary::
:nosignatures:
:toctree: moead_framework

Copy link
Contributor

Choose a reason for hiding this comment

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

moead_framework.tool.result.checkpoint should be added. Have you considered using the :members: directive instead of having to manually add every function?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added in the commit c3fce1e

Copy link
Contributor

@sjvrijn sjvrijn left a comment

Choose a reason for hiding this comment

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

Just hereby noting my approval of these changes while waiting for @chkoar

@chkoar
Copy link
Contributor

chkoar commented Jul 19, 2021

Just hereby noting my approval of these changes while waiting for @chkoar

To many changes to be reviewed one by one but it is definitely an improvement. I suppose it can safely be merged.

@geoffreyp geoffreyp merged commit b3e66a4 into moead-framework:master Jul 20, 2021
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.

[joss-reviews#2974] Checkpoints used inconsistently [joss-reviews#2974] Improve API docs
3 participants