Skip to content

Finalize structure of the repo #155

@gcroci2

Description

@gcroci2

🚨 TODOs to make the repo public 🚨

  • Go over the PRs and close/merge them
  • Go through folder in src/ and uniform them:
    • folder 3_ and 4_ need to have two subfolders, one for deeprank and one for deeprankcore @DarioMarzella, @DanLep97 move the scripts accordingly
    • check exploration/ and tools/ and create deeprank/deeprankcore subfolders and move there the relevant scripts (plotting results, loss curves, ...)
    • put into exploration/ and tools/ all scripts that can be considered as such, outside deeprank/deeprankcore subfolders if they are independent from them (or if they use both packages, e.g., plotting comparisons of deeprank/deeprankcore models)
    • move into exploration/ and tools/ scripts that are independent of the package used that now are in other places
    • add the readmes in each subfolder
  • change deeprankcore to DeepRank2 @gcroci2, to be aligned with DeepRank nomenclature and avoiding using the same name as the packages' ones (deeprank/deeprank2)
  • In src/ make the numbering consistent (all needs to start from 0 or 1, folders-wise and python files-wise) @gcroci2
  • create two branches, one for the paper (removing stuff not relevant for it), another one for keeping all the experiments/attempts/scripts: https://github.com/DeepRank/3D-Vac/tree/paper this is the branch for the paper
  • update the readme according to the current folders and scripts structure @gcroci2 and adjust the subfolders
  • Add MHCFlurry ref
  • clean `exploration/' folder. A short description of Dario's notebooks/scripts is still missing.
  • Clean the tools/ folder and document eventual remaining scripts. I have never used it, no script is documented so I don't know what I can delete.
  • update the readme with the links to the data, pre-trained models and outputs (TBD place-holders)
  • Make the repo public (or a fork of the repo)

TODOs asap, but fine also after having made the repo public:

  • we mention the additional features in DB4-DeepRank (e.g., desolvation energy). Did we use them? If not, update readme and delete the files accordingly.
  • Add Tadija's instructions about EGNN when he sends them.
  • Add Tadija's SSL part when he sends it.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions