Ch/update readme

[cleherny]

• I've updated the README to reflect the possibility of adding empty tiles or tiles including FP detection from a previous model + the multi-year aspect.
• I've also included some changes we discussed about the assert_year function. For now, I've changed the assert to if/else to test all possible combinations relating to the use of the year. There's probably a way of simplifying this. I'll let you test your idea of adding a 'year_tile' column to the extract_xyz function.
• Removing unnecessary lines from generate_tilesets.py.
• I've also applied some changes to the prepara_data.py script to reflect changes and feedback from proj-sda PRs. You don't need to review it.

[GwenaelleSa]

Thank you for the updates in the readme. They are good :)
I thought a little more about the function assert_year and the complicated if-else. I put my propositions in Slack.

[GwenaelleSa]

The function assess_year is much better like this 👍🏻
I still proposed small modifications, as Sonar Cube still says that the cognitive complexity is too high.

[GwenaelleSa]

You said it but did not do it.

[cleherny]

Exact. Now it's done.

[GwenaelleSa]

If we want to be perfectly correct here, we should avoid negative condition as much as possible. In addition, it would allow to shorten the code.

elif str(year).isnumeric() & ('year_tile' in tiles_gdf.keys()):
     logger.error("...")
     sys.exit(1)

[cleherny]

I did it like that trying to making explicit all the option but yes we can remove some lines.

[GwenaelleSa]

Same here, you could shorten by finishing with

elif 'year_tile' in tiles_gdf.keys():     # only possibility left for year is None or a non-authorized value
    logger.error("...")
    sys.exit(1)

[stdl-s-sonarqube]

Analysis Details

7 Issues

• 0 Bugs
• 0 Vulnerabilities
• 7 Code Smells

Coverage and Duplications

• No coverage information (0.00% Estimated after merge)
• 0.00% Duplicated Code (0.00% Estimated after merge)

Project ID: swiss-territorial-data-lab_object-detector_AYZ4zWIzr7JdaaSXwexc

View in SonarQube

[cleherny]

Thanks for your feedback that I have taken into account.
I have one question about l139 in the main README: I should update this line as well but I have a doubt about the definition. To what refer "A" and "B" exactly?

[cleherny]

Exact. Now it's done.

[cleherny]

I did it like that trying to making explicit all the option but yes we can remove some lines.

[GwenaelleSa]

In l. 139 of the README, A and B refer to any of the following ensemble: trn tiles, tst tiles, val tiles and oth tiles.
If A and B are not the same ensemble, their intersection is a null ensemble. It means that no tiles can be present in two of those ensembles.

I don't think you need to modify this line.