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

PyTorch migration: Finishing touches #187

Merged
merged 9 commits into from
Apr 8, 2021

Conversation

timokau
Copy link
Collaborator

@timokau timokau commented Apr 8, 2021

Description

This collects some misc fixes, changes and updates regarding the pytorch migration. I have updated the status in the README. The pytorch version does not have feature parity, but it is now at a point where it should be a viable replacement for at least some of the use cases.

Motivation and Context

Part of the ongoing pytorch migration.

How Has This Been Tested?

I ran the test suite and used our set of linters.

Does this close/impact existing issues?

Related to #125. I think the issue can be closed once the pytorch migration branch has been merged into master.

Types of changes

This contains various documentation changes as well as a breaking change to the CmpNet estimators.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.

timokau added 3 commits April 8, 2021 23:09
The previous explanation was taken from FATE and does not correctly
describe the FETA approach.
@timokau timokau force-pushed the migration-updates branch from e4364f2 to 31a4a4e Compare April 8, 2021 21:23
@timokau timokau changed the base branch from master to pytorch-migration April 8, 2021 21:25
@timokau timokau requested a review from kiudee April 8, 2021 21:26
@kiudee kiudee self-requested a review April 8, 2021 21:32
Copy link
Owner

@kiudee kiudee left a comment

Choose a reason for hiding this comment

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

Just found a minor typo. The cross-referencing suggestion is not that important.

timokau added 6 commits April 8, 2021 23:53
The documentation of the scoring approach is now consistently delegated
to the docstring of the scoring module. I think that is better, even if
it is a bit harder for the user to find the descripütion. Duplicate
documentation would just get out of sync and increases the friction for
improvements. The class references should make it easy enough to find
the relevant documentation.
This is somewhat contrary to the comment I wrote in the general choice
test. I have since noticed a similar issue with RankNet in the tests. It
seems that SELU just works better, at least for these tiny toy problems.
Its already the default for the other pytorch based estimators. I think
it makes sense to use it as the default for CmpNet as well.
It can be useful to compare the network sizes that are used for the
different estimators at a glance. The CmpNet test specifications already
list the `n_hidden` and `n_unit` arguments even though they match the
default values. This change makes the specifications more consistent.
I have added them in alphabetical order, which is why the order has
changed in `discretechoice.rst`.
@timokau timokau force-pushed the migration-updates branch from a293d1b to 16a4327 Compare April 8, 2021 21:55
@kiudee kiudee self-requested a review April 8, 2021 21:58
@timokau
Copy link
Collaborator Author

timokau commented Apr 8, 2021

I fixed the typo, added cross-referencing, fixed the choicefunction module name in the api docs and added the missing estimators to the api docs.

The references are not rendered as links. Sphinx gives some unrelated warnings, but does not complain about the references. It might be a configuration option. The sphinx warnings are related to the docstring indentation of some of the older estimators. I think the they could be fixed by using the latest version of black (which also considers docstrings to some degree) on them.

The full access path should still make it easier to find the relevant documentation.

@timokau
Copy link
Collaborator Author

timokau commented Apr 8, 2021

Thank you for the review :)

@timokau timokau merged commit 086b7c0 into kiudee:pytorch-migration Apr 8, 2021
@timokau timokau deleted the migration-updates branch April 8, 2021 22:05
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.

2 participants