kiudee / cs-ranking

Context-sensitive ranking and choice in Python with PyTorch
https://cs-ranking.readthedocs.io
Apache License 2.0
66 stars 15 forks source link

PyTorch migration: Finishing touches #187

Closed timokau closed 3 years ago

timokau commented 3 years ago

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.

Checklist:

timokau commented 3 years ago

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 commented 3 years ago

Thank you for the review :)