Add IInstance Interface. - Githubissues

lucawrabetz / opti-face

A suite of tools for automating experiments in computational research.

MIT License

8 stars 1 forks source link

Add IInstance Interface. #17

Open lucawrabetz opened 1 month ago

lucawrabetz commented 1 month ago

Overview

Add the initial version of the Instance interface (IInstance), which defines the contract for an instance of a problem.

Description

It is only required to have the properties:

set_name
id (rep) [naming to be discussed, id might be a bit confusing*]
filename (function of set_name, parameters, id)

I'll start with these.

Then we have to figure out the best way to design the following:

instance parameters

instance parameters should exactly match the additional features added to the datamodel by the user (see issue #16). Design options below.

on id & rep: this is when you generate e.g. 30 instances with the same set_name and parameters for statistical significance.

The user will inherit this class and add some more data properties to it.

Possible solutions or directions

Regarding the instance parameters, they could be, very broadly speaking:

generated based on the instance parameter subset of the schema we are working on in (#16)
we could require the user to add them and then post-validate them

If there is a clean way to do it, the first option seems to make a lot more sense to me.

lucawrabetz commented 1 month ago

Going with rep for now instead of id. It seems less confusing in general, and id is a reserved keyword in python.