search

unibe-cns / NEAT

NEAT (NEural Analysis Toolkit)
Other
12 stars 15 forks source link

Refactor fit functions from `neat.CompartmentTree` #117

Open WillemWybo opened 3 years ago

WillemWybo commented 3 years ago

Currently, neat.CompartmentTree contains many auxiliary functions required for fitting that are not really supposed to be part of the API. They should be moved to a seperate derived class within the neat.tools.fittools.compartmentfitter module, so that neat.CompartmentTree retains a more streamlined API.

jakobj commented 3 years ago

i'm not sure i understand but if you mean that the class contains functions which are only supposed to be used internally, not by the user, what about prefixing them with an underscore? that's the usual convention for telling users "don't use this directly". may be faster than creating a derived class. although of course a bit less clean ;)

WillemWybo commented 3 years ago

Well, they are not meant to be private to the class, as other classes call them. It shouldn't be much work to create a derived class.