ds5110 / faces

3 stars 0 forks source link

Cleaning Up Main #8

Closed CCLynch closed 1 year ago

CCLynch commented 1 year ago

Things to remove from Main branch:

Topics

Here are the interesting subjects that we are exploring and want to make sure we document and describe:

Documentation

all these files will live at the root of the repo:

Src Organization

  1. Drivers for each model (which use files in util)
  2. Util
    • contains all helpers, especially anything that can be used on multiple models
    • all the stuff related to preprocessing and plotting
  3. ...extra discretionary files for specific models, with the file name starting with our initials.
jhautala commented 1 year ago

I think this issue can be closed; we've implemented most of these items.

There are a few driver scripts in the util package that should be moved up to the src directory, but that should be addressed under issue 18.

CCLynch commented 1 year ago

Agreed