this repo has no description
anil.recoil.org
1opam-version: "2.0"
2maintainer: "Liang Wang <ryanrhymes@gmail.com>"
3authors: [ "Liang Wang" ]
4license: "MIT"
5homepage: "https://github.com/owlbarn/owl"
6dev-repo: "git+https://github.com/owlbarn/owl.git"
7bug-reports: "https://github.com/owlbarn/owl/issues"
8doc: "https://owlbarn.github.io/"
9
10build: [
11 [ "jbuilder" "subst" "-p" name ] {dev}
12 [ "jbuilder" "build" "-p" name "-j" jobs ]
13]
14
15depends: [
16 "ocaml" {>= "4.06.0"}
17 "alcotest" {with-test}
18 "base-bigarray"
19 "jbuilder" {>= "1.0+beta7"}
20]
21synopsis: "An OCaml Numerical Library"
22description: """
23Owl is an emerging numerical library for scientific computing and engineering. The library is developed in the OCaml language and inherits all its powerful features such as static type checking, powerful module system, and superior runtime efficiency. Owl allows you to write succinct type-safe numerical applications in functional language without sacrificing performance, significantly reduces the cost from prototype to production use.
24
25Behind the scene, Owl builds the advanced numerical functions atop of its solid implementation of n-dimensional arrays. Quite different from other libraries, algorithmic differentiation and distributed computing have been included as integral components in the core library to maximise developers' productivity. Owl is young but grows fast, the current features include:
26
27* N-dimensional array (both dense and sparse)
28* Various number types: `float32`, `float64`, `complex32`, `complex64`, `int8`, `int16`, `int32` ...
29* Linear algebra and full interface to CBLAS and LAPACKE
30* Algorithmic differentiation (or automatic differentiation)
31* Neural network module for deep learning applications
32* Dynamic computational graph allowing greatest flexibility for applications
33* Parallel and Distributed engine (map-reduce, parameter server, etc.)
34* Advanced math and stats functions (e.g., hypothesis tests, MCMC, etc.)
35* Zoo system for efficient scripting and code sharing
36* GPU support (work in progress ...)
37
38You can reach us in the following ways, looking forward to hearing from you!
39
40- [Email Me](mailto:liang.wang@cl.cam.ac.uk)
41- [Slack Channel](https://join.slack.com/t/owl-dev-team/shared_invite/enQtMjQ3OTM1MDY4MDIwLTA3MmMyMmQ5Y2U0NjJiNjI0NzFhZDAwNGFhODBmMTk4N2ZmNDExYjZiMzI2N2M1MGNiMTUyYTQ5MTAzZjliZDI)
42
43
44
45## Learning
46
47Owl's documentation contains a lot of learning materials to help you start. The full documentation consists of two parts: [Tutorial Book](http://www.cl.cam.ac.uk/~lw525/owl/chapter/index.html) and [API Reference](http://www.cl.cam.ac.uk/~lw525/owl/apidoc/index.html). Both are perfectly synchronised with the code in the repository by the automatic building system. You can access both parts with the following link.
48
49* [Owl's Full Documentation](http://www.cl.cam.ac.uk/~lw525/owl/)
50
51
52
53## Installation
54
55Owl requires OCaml `>=4.06.0`. The installation is rather trivial. There are four possible ways to try out Owl, as shown below, from the most straightforward one to the least one.
56
57### Option 1: Install from OPAM
58
59You can simply type the following in the command line to start.
60
61```bash
62opam install owl
63```
64
65Owl's current version on OPAM is `0.2.9`, and it lags way behind the master branch (current `0.3.4`) and misses many new features. If you want to try the newest version, I recommend the other three ways to install.
66
67### Option 2: Pull from Docker Hub
68
69You only need to pull in [Owl's docker image](https://hub.docker.com/r/owlbarn/owl/) and start a container, then play with it in `utop`. The source code is stored in `/root/owl` directory.
70
71```bash
72docker pull owlbarn/owl
73docker run -t -i owlbarn/owl
74```
75
76There are several Linux distributions provided including an [ARM-based Ubuntu](https://github.com/owlbarn/owl/blob/master/docker/Dockerfile.ubuntu.arm). You can pull in a specific Owl image with corresponding tags.
77
78```bash
79docker pull owlbarn/owl:ubuntu
80docker pull owlbarn/owl:debian
81docker pull owlbarn/owl:alpine
82docker pull owlbarn/owl:centos
83docker pull owlbarn/owl:opensuse
84docker pull owlbarn/owl:fedora
85```
86
87All these images are perfectly synced with the master branch by automatic building. You can check the building history on [Docker Hub](https://hub.docker.com/r/owlbarn/owl/builds/).
88
89### Option 3: Pin the Dev-Repo
90
91`opam pin` allows us to pin the local code to Owl's development repository on Github. The first command `opam depext` installs all the dependencies Owl needs.
92
93```bash
94opam depext owl
95opam pin add owl --dev-repo
96```
97
98### Option 4: Compile from Source
99
100First, you need to clone the repository.
101
102```bash
103git clone git@github.com:owlbarn/owl.git
104```
105or with
106
107```bash
108git clone https://github.com/owlbarn/owl.git
109```
110
111Second, you need to figure out the missing dependencies and install them.
112
113```bash
114jbuilder external-lib-deps --missing @install
115```
116
117Last, this is perhaps the most classic step.
118
119```bash
120make && make install
121```
122
123### CBLAS/LAPACKE Dependency
124
125The most important dependency is [OpenBLAS](https://github.com/xianyi/OpenBLAS). Linking to the correct OpenBLAS is the key to achieve the best performance. Depending on the specific platform, you can use `yum`, `apt-get`, `brew` to install the binary format. For example on Mac OSX,
126
127```bash
128brew install openblas
129```
130
131However, installing from OpenBLAS source code leads to way better performance in my own experiment. In future, the dependency on OpenBLAS should also be resolved by `opam` automatically.
132
133### Integration to Toplevel
134
135Owl is well integrated with `utop`. You can use `utop` to try out the experiments in our tutorials. If you want `utop` to automatically load Owl for you, you can also edit `.ocamlinit` file in your home folder by adding the following lines. (Note that the library name is `owl` with lowercase `o`.)
136
137```bash"""
138url {
139 src:
140 "https://github.com/owlbarn/owl/releases/download/0.3.8/owl-base-0.3.8.tbz"
141 checksum: [
142 "sha256=7e7725e9a1a967b2af54d7f091a0aea76c54e9abeb4220947921864ef6ffe7d0"
143 "md5=247e4b6e6190df68830095441e71e69a"
144 ]
145}