Skip to content

Commit

Permalink
Merge branch 'main' into developer
Browse files Browse the repository at this point in the history
  • Loading branch information
LiamCPinchbeck authored Sep 2, 2024
2 parents a82b71f + e8f7f9f commit 83a159b
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,8 @@ A stable python package version of the code exists on `PyPi` that can be install

This will also take care of the required dependencies for the project.

We recommend to look through the tutorials for an overview of the functionality of the code however, the figure below shows the main classes of `GammaBayes` in a UML diagram. The main information that one can glean from this are the main classes to understand and what classes need what other `GammaBayes` classes to function. So for example if you just want to use `DiscreteLogPrior` there is a little to understand but not a lot, but if you want to fully understand `ScanOuput_StochasticTreeMixturePosterior` then you essentially need to know everything else in the package to some degree.

For those unfamiliar with UML the diamonds mean that the object that has the diamond next to it has instances of the other connected class, arrows point at classes dependent on the other class (with the other class not necessarily impact by the one pointed at) and clear arrows point at the class that a parent class. However, all I'm trying to show here are the main classes, methods and attributes involved with `GammaBayes` and what classes they are at least related to in some way.
We recommend to look through the tutorials for an overview of the functionality of the code however, the figure below shows the main classes of `GammaBayes` in a UML diagram.


![Alt text](https://raw.githubusercontent.com/lpin0002/GammaBayes/main/misc/GammaBayes_UML.png)

0 comments on commit 83a159b

Please sign in to comment.