-
Notifications
You must be signed in to change notification settings - Fork 8
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
update documentation with tools api #55
Conversation
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):: |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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 | ||
|
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this 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
To many changes to be reviewed one by one but it is definitely an improvement. I suppose it can safely be merged. |
No description provided.