SheffieldML/GPy

There are `assert`s where we need `ValueError`s

Open

#922 opened on May 27, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (1,927 stars) (579 forks)batch import
good first issue

Description

We should not use assert to address bad user input, but there are such uses of assert in the GPy codebase. Instead, we should use ValueError. For more details, see https://github.com/SheffieldML/GPy/pull/917#discussion_r639520080

Contributor guide

Tech stack
python
Domain
developer experiencemachine learning
Issue type
refactor
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python basicsUnderstanding of exceptions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Review the linked PR discussion at https://github.com/SheffieldML/GPy/pull/917#discussion r639520080 to understand which specific asserts should be replaced. Then search the GPy codebase for all instances of `assert` that validate user input (as opposed to internal assertions) and replace each with an appropriate `raise ValueError(...)`. Common files include modules in `GPy/core/` or other input handling code.