Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

PB-366 flatten weights #253

Merged
merged 6 commits into from
Feb 4, 2020
Merged

Conversation

janpetschexain
Copy link
Contributor

@janpetschexain janpetschexain commented Feb 3, 2020

References

Summary

  • use flat weights instead of list of weights
  • update tests accordingly
  • update documentation accordingly
  • removed hellonumproto examples and tests

tested by running a dockerized coordinator and local participants on both sdk examples.

Are there any open tasks/blockers for the ticket?

  • none

Reviewer checklist

Reviewer agreement:

  • Reviewers assign themselves at the start of the review.
  • Reviewers do not commit or merge the merge request.
  • Reviewers have to check and mark items in the checklist.

Merge request checklist

  • Conforms to the merge request title naming XP-XXX <a description in imperative form>.
  • Each commit conforms to the naming convention XP-XXX <a description in imperative form>.
  • Linked the ticket in the merge request title or the references section.
  • Added an informative merge request summary.

Code checklist

  • Conforms to the branch naming XP-XXX-<a_small_stub>.
  • Passed scope checks.
  • Added or updated tests if needed.
  • Added or updated code documentation if needed.
  • Conforms to Google docstring style.
  • Conforms to XAIN structlog style.

@@ -348,15 +348,15 @@ where the request and response data are given as the following protobuf messages
message StartTrainingRoundRequest {}

message StartTrainingRoundResponse {
repeated xain_proto.numproto.NDArray weights = 1;
xain_proto.np.NDArray weights = 1;
Copy link
Contributor

@wilk10 wilk10 Feb 3, 2020

Choose a reason for hiding this comment

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

i understand this has been implemented elsewhere in this way (xain_proto repo), but i would advise against using the np abbreviation because that is a convention reserved for the actual numpy package, which may cause some confusion. but it doesn't quite fall under the scope of this PR, i guess

Copy link
Contributor Author

Choose a reason for hiding this comment

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

np was chosen explicitly as it stands for numpy (not numproto) to indicate directly that this is a protobuf implementation of numpy, as well as the associated utilites.

"""An abstract class that defines the API a store must implement.

"""
"""An abstract class that defines the API a store must implement."""
Copy link
Contributor

Choose a reason for hiding this comment

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

if the only changes to this file are about the docstrings and don't change any functionality, then i wouldn't include this in the PR, otherwise it may cause confusion in the commit history

Copy link
Contributor Author

Choose a reason for hiding this comment

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

since it doesn't change the content/meaning of the docstring but only the formatting, i consider this simple cleanup which shouldn't require a dedicated ticket.

Copy link
Contributor

@wilk10 wilk10 left a comment

Choose a reason for hiding this comment

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

thanks! looks pretty good. only some comment for readability (i didn't test it locally though)

finiteprods
finiteprods previously approved these changes Feb 3, 2020
Copy link
Contributor

@finiteprods finiteprods left a comment

Choose a reason for hiding this comment

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

just minor comments, otherwise looks fine.

Copy link
Member

@PanicButtonPressed PanicButtonPressed left a comment

Choose a reason for hiding this comment

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

Looks good, but it seems the branch has to be rebased first.

@janpetschexain janpetschexain merged commit 8bf2f11 into development Feb 4, 2020
@janpetschexain janpetschexain deleted the PB-366-flatten_weights branch February 4, 2020 09:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants