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

Simplify argument parsing, update docs in ALBERT example #315

Merged
merged 6 commits into from
Jul 13, 2021

Conversation

mryab
Copy link
Member

@mryab mryab commented Jul 11, 2021

This PR updates the documentation in the ALBERT examples to replace all mentions of "the coordinator" with "the training monitor" after #308. Also, the argument parsing logic in run_trainer.py is refactored to avoid the current convoluted and error-prone solution of "convert all arguments to a dictionary - pop the arguments you do not need - pass all of the rest to the optimizer". Finally, it contains minor changes in the guide/docstrings meant to improve their clarity.

@mryab mryab requested review from yhn112 and justheuristic July 11, 2021 15:53
@mryab mryab changed the title Simplify argument parsing and update documentation in example Simplify argument parsing, update docs in ALBERT example Jul 11, 2021
@codecov
Copy link

codecov bot commented Jul 11, 2021

Codecov Report

Merging #315 (10ab463) into master (2f07a55) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #315   +/-   ##
=======================================
  Coverage   82.06%   82.06%           
=======================================
  Files          66       66           
  Lines        5898     5898           
=======================================
  Hits         4840     4840           
  Misses       1058     1058           
Impacted Files Coverage Δ
hivemind/utils/timed_storage.py 95.91% <0.00%> (-1.03%) ⬇️
hivemind/averaging/matchmaking.py 77.23% <0.00%> (-0.31%) ⬇️
hivemind/averaging/key_manager.py 97.72% <0.00%> (+2.27%) ⬆️

current_step = latest_step
alive_peers = 0
num_batches = 0
Copy link
Member Author

Choose a reason for hiding this comment

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

This variable is not used

@mryab mryab added the documentation Improvements or additions to documentation label Jul 11, 2021
@yhn112
Copy link
Member

yhn112 commented Jul 12, 2021

Beautiful
(But will continue reviewing later this evening)

@mryab mryab force-pushed the refactor_examples branch from 38888cc to 888feed Compare July 12, 2021 19:09
@mryab mryab merged commit d97fede into master Jul 13, 2021
@mryab mryab deleted the refactor_examples branch July 13, 2021 14:49
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.

3 participants