facebookresearch/ParlAI

[bert_ranker] Should be overriding build_criterion

Open

#2,019 opened on Sep 26, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (10,371 stars) (2,089 forks)batch import
CS5152Help WantedMinordonotreap

Description

Bug description Created from #2003.

The self.rank_loss in bi_encode_ranker (and possibly the others) should be created by overriding the build_criterion rather than directionly setting self.rank_loss.

https://github.com/facebookresearch/ParlAI/blob/028753ff0cbc293037117f1b0bb07eb7e7335093/parlai/agents/bert_ranker/bi_encoder_ranker.py#L57

Contributor guide

Tech stack
python
Domain
machine learningbackend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonParlAI codebase structureobject oriented programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the base class to understand the expected signature of build criterion. Then, in the file parlai/agents/bert ranker/bi encoder ranker.py, replace the direct assignment of self.rank loss with an override of the build criterion method. Additionally, check other ranker files (e.g., cross encoder ranker.py) for similar issues. Review the linked parent issue #2003 for context.