Key Components 🗝️
CheckSet
The UpTrain equivalent of a test suite
A CheckSet
specifies a collection of Check objects run against the same dataset. It is a higher level construct to make scheduling and running multiple checks easier.
A CheckSet
in UpTrain takes three arguments:
- source - The location of the file along with the corresponding Reader Operator.
- preprocessors - The list of operators to run on the input data before running the checks.
- checks - The set of checks to be run on the input data after preprocessing.
The CheckSet
class implements two methods, which are to be run in order:
setup()
- This method performs the setup before therun()
method is called. You can pass a Settings object with the required configurations.run()
- Reads the data and runs all theChecks
A CheckSet
object can optionally be serialized and run remotely.