[Enhancement] Extra steps and error messages in schema validation about omrchecker HOT 9 OPEN

We can close the previous issue and update this one.

from omrchecker.

In #43 we added a json schema, which is basically a blueprint for the input template.json file, that validates the template file and we wrote a function that validates the template using python jsonschema library. Both the schema and the error messages need a lot of improvement and that is where this issue comes in.

1. Talking about improvements in the validation schema, we have to write the constraints in much more detail. By constraint I mean for eg: the dimensions key should only take in an array of 2 integers, so if the number of integers don't match, it should give a proper error message. So, detailed constraints have to be included in the schema.

2. Regarding the error messages, currently we only print the key where the error takes place (key comes from schema and not the input template which is a problem) and we print a default error message which is not sufficient currently. So we need to improve the error messages, add a warning/error info/level and also find a way to get the key with the error from the input template.json instead of the schema (for cases of spelling mistake or case mistake in the keys).

from omrchecker.

@SpyzzVVarun are you available to work on this now?

from omrchecker.

Well detailed breakdown 👍
you(and others) can raise PRs in small mergeable/deliverable chunks as we discussed yesterday.

Reiterating that discussion here as well for reference -

I'll share a concept I shared with one of you recently.

This comes from Agile development practiced in the industry.

Break the task down into as many parts as possible, as long as one meaningful PR for each of the parts exists. This helps in teams and communities to work independently and efficiently

from omrchecker.

@SpyzzVVarun adding few more criteria

• inner schema of each QBlock should be validated too.
• singles array should not contain duplicate qNos
• concatenations keys + arrays should not contain duplicate qNos

from omrchecker.

This issue needs a bit more attention now. Bumping updated time with this comment.

from omrchecker.

Marking issue as easy since a few improvements have been merged in the evaluation + revamp PR #118

from omrchecker.

Sir i would like to contribute to this project. Please tell me how, I'm pretty new to Open Source.

from omrchecker.

@anaghninja432 Hello, if you're new to the project I suggest you to run the project locally on a new OMR sheet and submit a sample. Then in the process try to go through the code flow for your images. This task is around schema validation so you can experiment passing incorrect template jsons by thinking of common mistakes people can do. We need to provide accurate error messages to guide the user

from omrchecker.