Skip to content

Commit a0d53ed

Browse files
committed
FIX: Update Readme with correct docs links
Signed-off-by: KyleErwin <[email protected]>
1 parent 2515a54 commit a0d53ed

File tree

2 files changed

+44
-15
lines changed

2 files changed

+44
-15
lines changed

README.md

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[![Build Status](https://github.com/IBM/LNN/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/IBM/LNN/actions/workflows/build.yml?query=branch%3Amaster)
12
[![License](https://img.shields.io/badge/license-Apache%202.0-blueviolet)](https://github.com/IBM/LNN/blob/master/LICENSE)
23
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5926/badge)](https://bestpractices.coreinfrastructure.org/projects/5926)
34
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
@@ -21,27 +22,55 @@ properties of both neural nets (learning) and symbolic logic (knowledge and reas
2122
## Quickstart
2223
To install the LNN:
2324
1. Install [GraphViz](https://www.graphviz.org/download/) and gmp (libgmp3-dev)
24-
<details><summary>Tips for errors "'gmp.h' file not found" and "'graphviz/cgraph.h' file not found" on Mac</summary><div>
25-
25+
<details>
26+
<summary>Tips for installing Graphviz</summary>
27+
<div>
28+
If you experience a "graphviz/cgraph.h" file not found error, try the following:
29+
30+
```bash
31+
# Using Conda
32+
conda install -c anaconda graphviz
33+
```
34+
Alternatively you can install the OS specific versions as follows:
2635
```bash
36+
# Ubuntu and Debian
37+
sudo apt-get install graphviz graphviz-dev
38+
```
39+
```bash
40+
# MacOS
2741
brew install graphviz
28-
# check the graphviz path from `brew info graphviz`
29-
export GRAPHVIZ_DIR="/usr/local/Cellar/graphviz/3.0.0"
30-
pip install pygraphviz --global-option=build_ext --global-option="-I$GRAPHVIZ_DIR/include" --global-option="-L$GRAPHVIZ_DIR/lib"
42+
```
43+
```bash
44+
# Windows
45+
sudo apt-get install python3-dev graphviz libgraphviz-dev pkg-config
46+
```
47+
</div></details>
48+
49+
<details>
50+
<summary>Tips for installing gmp</summary>
51+
<div>
3152

53+
If you experience a "gmp.h" file not found error, try the following:
54+
```bash
55+
# MacOS
3256
brew install gmp
3357
env "CFLAGS=-I/usr/local/include -L/usr/local/lib" pip install pycddlib
3458
```
59+
```bash
60+
# Windows
61+
sudo apt-get install python3-dev graphviz libgraphviz-dev pkg-config
62+
sudo -H apt-get install libgmp-dev python3-dev
63+
```
3564
</div></details>
3665

3766
2. Make sure that the python version you use in line with our [setup](https://github.com/IBM/LNN/blob/master/setup.py) file, using a fresh environment is always a good idea:
3867
```commandline
39-
conda create -n lnn-contrib python=3.9 -y
40-
conda activate lnn-contrib
68+
conda create -n lnn python=3.9 -y
69+
conda activate lnn
4170
```
42-
3. Install the `develop` branch to keep up to date with the latest supported features:
71+
3. Install the LNN as a library:
4372
```commandline
44-
pip install git+https://github.com/IBM/LNN.git@develop
73+
pip install git+https://github.com/IBM/LNN.git
4574
```
4675

4776
## Contribution
@@ -66,9 +95,9 @@ reference paper:
6695
}
6796
```
6897

69-
[Docs]: https://pages.github.com/IBM/LNN/introduction.html
70-
[Papers]: https://pages.github.com/IBM/LNN/papers.html
71-
[Education]: https://pages.github.com/IBM/LNN/education/education.html
72-
[API]: https://pages.github.com/IBM/LNN/usage.html
73-
[Module]: https://pages.github.com/IBM/LNN/lnn/LNN.html
98+
[Docs]: https://ibm.github.io/LNN/introduction.html
99+
[Papers]: https://ibm.github.io/LNN/papers.html
100+
[Education]: https://ibm.github.io/LNN/education/education.html
101+
[API]: https://ibm.github.io/LNN/usage.html
102+
[Module]: https://ibm.github.io/LNN/lnn/LNN.html
74103
[Neuro-Symbolic AI]: https://research.ibm.com/teams/neuro-symbolic-ai

docs/_static/images/arrow-right-with-tail.svg

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)