Backend parameters and documentation

mazfil / lab-allocator

COMP3500 - Resource maximisation planning system for labs

3 stars 1 forks source link

Backend parameters and documentation #89

Open alexdboxall opened 3 months ago

alexdboxall commented 3 months ago

Probably can be split into two issues later, but need to:

Ensure that the backend can get the parameters from the front end about how the fitness function is weighted
Actually use those parameters
Write some user-level documentation about what the effect of those parameters are

Edward-Nivison commented 3 months ago

Reflection is related to this issue, make sure that when you are developing this that you reference here about what you do!

Being able to see the list of restrictions/priorities for lab allocation and how they can be updated in the future would be useful.

My recommendation is that we have a user manual/guide/info-manual that details what is being considered by the algorithm, how things could be tweaked to change priorities and such.

Referencing reflection issue #92.

matthewcawley02 commented 3 months ago

Added user-level documentation for how the backend parameters work, in the user-preferences folder.

As for the first dotpoint, still need to wait for new database to be deployed to add connection to backend.

Edward-Nivison commented 2 months ago

Got a debrief from Alex about the Fitness function again, I will work on making it visual and get it confirmed from Alex or Matthew that it is correct.

Edward-Nivison commented 1 month ago

@matthewcawley02 could you look at the wiki that I have made for the frontend wiki. If there is anything that I have misunderstood or could be better communicated let me know!