Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
timkucera authored Nov 24, 2023
1 parent 80f1e06 commit 483de0e
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions proteinshake/readme.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
## Filestructure:

**backend:** Collects and processes raw pdb files from various databases. Creates Collections.
- **backend:** Collects and processes raw pdb files from various databases. Creates Collections.

**adapters:** Database adapters to PDB, AFDB, etc.
- **adapters:** Database adapters to PDB, AFDB, etc.

**protein:** The protein object specification.
- **protein:** The protein object specification.

**collection:** A set of protein objects.
- **collection:** A set of protein objects.

**database:*** Unifying database mirror that allows query access to create a collection.
- **database:*** Unifying database mirror that allows query access to create a collection.

**frontend:** High level specifications for datasets and tasks.
- **frontend:** High level specifications for datasets and tasks.

**datasets:** Load a collection and apply transforms.
- **datasets:** Load a collection and apply transforms.

**tasks:** Various ML prediction problems. Takes a dataset and rearranges the data (sklearn-style X_train, y_train, ...) such that it can be fed to the model (X) and evaluated (y).
- **tasks:** Various ML prediction problems. Takes a dataset and rearranges the data (sklearn-style X_train, y_train, ...) such that it can be fed to the model (X) and evaluated (y).

**evaluators:** Groups relevant metrics for a given class of problems (e.g. classification or regression).
- **evaluators:** Groups relevant metrics for a given class of problems (e.g. classification or regression).

**splitters:** Takes a dataset and generates split indices, either from the data/labels itself or from other resources.
- **splitters:** Takes a dataset and generates split indices, either from the data/labels itself or from other resources.

**datasets:** Some relevant collections of proteins, for preprocessed hosting. Each dataset covers some biological topic.
- **datasets:** Some relevant collections of proteins, for preprocessed hosting. Each dataset covers some biological topic.

**tasks:** The actually implemented biological tasks for the end-user, consisting of a frontend.task in combination with a specific dataset.
- **tasks:** The actually implemented biological tasks for the end-user, consisting of a frontend.task in combination with a specific dataset.

**transforms:** Various functions to transform proteins, representations, and frameworks.
- **transforms:** Various functions to transform proteins, representations, and frameworks.

0 comments on commit 483de0e

Please sign in to comment.