Skip to content
Miguel Tenorio edited this page Nov 25, 2020 · 4 revisions

In this wiki you will know what a model is, and how to create a new one.

A model is a object that process the votes or calendars proposed by the users that take part to the discussion with this and return a calendar that would represents the consensus of the discussion.

A abstract class named BaseModel was created to support the creations of several models.

Now the steps to create a new model:

  1. Create a my_model.py in src/model or in src\model for Windows users. We'll refer to the work within this file from now on.
  2. Create a class that inherits from BaseModel. See DEA/AR model for a good example. Pay attention to the way the docstring is written. You must respect that if you want your model description displayed nicely by the output of the /models command.
  3. Implement solve function.

Optionally if you don't has a complex model to implement, maybe you would like to inherits from SimpleModel and define your own expected bahavior for distance and merge functions. See Positions as example.

Clone this wiki locally