Skip to content

Commit

Permalink
#12 Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
danielkorzekwa committed Mar 3, 2015
1 parent 5c05aab commit 8e97f56
Showing 1 changed file with 40 additions and 4 deletions.
44 changes: 40 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,42 @@

It is a Scala library for building Bayesian Networks with discrete/continuous variables and running deterministic Bayesian inference.

## How to uses it from sbt and maven?

Snapshot artifact is build by a Travis CI and deploymet to Sonatype OSS Snapshots repository with every commit to Bayes-scala project. Released versions of Bayes-scala (non-snapshots) are not available at the moment.

With sbt build tool, add to build.sbt config file:

```
libraryDependencies ++= Seq(
"com.github.danielkorzekwa" % "bayes-scala_2.10" % "0.5-SNAPSHOT"
)
resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"
```

With maven build tool, add to pom.xml config file:

```scala
<repositories>
<repository>
<id>oss-sonatype-snapshots</id>
<name>oss-sonatype-snapshots</name>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>com.github.danielkorzekwa</groupId>
<artifactId>bayes-scala_2.10</artifactId>
<version>0.5-SNAPSHOT</version>
</dependency>
<dependencies>
```

## Examples

* Examples illustrating the usage of a high level API for building Bayesian Networks
* [Student Bayesian Network](#student-bayesian-network)
* [Monty Hall problem](#monty-hall-problem)
Expand All @@ -11,10 +47,6 @@ It is a Scala library for building Bayesian Networks with discrete/continuous va
* [Gaussian process regression with cluttered Gaussian likelihood](#gaussian-process-regression-with-cluttered-gaussian-likelihood)
* [1D Kalman filter](#1d-kalman-filter)

* [Low level algorithms] which are used behind the scenes for Bayesian Inference, e.g. Loopy Belief Propagation, Expectation Propagation

## Examples

### Student Bayesian Network

Bayesian Networks diagram was created with the [SamIam] tool.
Expand Down Expand Up @@ -175,6 +207,10 @@ Infer new gaussian state given two noisy observation
infer(x) // Gaussian(1.0341,0.2647)
```

## Others

* [Low level algorithms] which are used behind the scenes for Bayesian Inference, e.g. Loopy Belief Propagation, Expectation Propagation

[Low level algorithms]: https://github.com/danielkorzekwa/bayes-scala/blob/master/doc/lowlevel/README.md
[SamIam]: http://reasoning.cs.ucla.edu/samiam/
[TrueSkill]: http://research.microsoft.com/en-us/projects/trueskill/
Expand Down

0 comments on commit 8e97f56

Please sign in to comment.