You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 26, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: _sources/installation.rst.txt
+3-37Lines changed: 3 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,8 @@
2
2
Installation
3
3
============
4
4
5
-
Graphbrain requires Python >=3.9 and runs on macOS, Linux and Windows.
5
+
Graphbrain requires Python >=3.10.
6
6
7
-
We currently have binary releases for macOS only. Given a working build environment, installation on Linux should be equally simple. Installation on Windows is at the moment less straightforward, because of our dependency on LevelDB, which in turn requires a bit of effort to install in this OS. `For such cases or to build from the sources, check the prerequisites for your OS <#prerequisites>`_.
8
-
9
-
.. warning::
10
-
*Important for macOS users:* You will need to install a specific version of LevelDB before installing Graphbrain. `Please refer to the prerequisites section below for details <#macos>`_.
11
7
12
8
Install with pip
13
9
================
@@ -52,16 +48,6 @@ In case both models are present, Graphbrain will use the transformer model. A sp
52
48
53
49
$ pip uninstall en_core_web_trf
54
50
55
-
Coreference resolution
56
-
----------------------
57
-
58
-
If you want to perform coreference resolution, you will need to install the transformer model and also the following model::
Coreference resolution currently requires version 0.6.1 of the package ``spacy-experimental`` (`more info <https://github.com/explosion/spacy-experimental/releases/tag/v0.6.1>`_). Graphbrain requirements specify this version, but if you run into problems make sure you have the correct one installed.
64
-
65
51
Install from the code repository (github)
66
52
=========================================
67
53
@@ -75,10 +61,6 @@ Start by cloning the source code to your current local directory.
75
61
76
62
It is advisable to work with virtual environments, for reasons that are explained in the previous section. Please refer to it for details.
77
63
78
-
Install Cython::
79
-
80
-
$ pip install cython
81
-
82
64
Now you can build and install graphbrain::
83
65
84
66
$ pip install .
@@ -89,7 +71,7 @@ If you are working on graphbrain development or wish to modify the code for your
89
71
90
72
This way, graphbrain will be added to your environment by linking to the local project directory, which means that any change in the code will reflect directly in the environment. Another important consequence of this is that you will be able to import graphbrain from the project directory and run development tools such as `pytest`, otherwise there could be conflicts caused by the `graphbrain` package in the current path not containing the compiled cython modules.
91
73
92
-
It is then necessary to download a spaCy language model and optionally the coreference resolution model, as detailed above.
74
+
It is then necessary to download a spaCy language model, as detailed above.
93
75
94
76
For developers
95
77
--------------
@@ -103,9 +85,8 @@ Run tests
103
85
104
86
From the project's root directory::
105
87
106
-
$ pytest graphbrain
88
+
$ pytest
107
89
108
-
Notice that this requires graphbrain to have been installed with the `-e` pip flag, and for the `pytest` package to be installed. The `pytest` package is included in the above mentioned development dependencies.
109
90
110
91
Prerequisites
111
92
=============
@@ -145,18 +126,3 @@ If python 3 is not already included with your current version os macOS::
(this formula was forked from this repository: https://github.com/bagonyi/homebrew-formulae, our thanks to David Bagonyi for creating it!)
158
-
159
-
Users with M-Series Macs must add the homebrew path (to .bashrc or .zshrc) (see https://github.com/wbolster/plyvel/issues/100#issuecomment-1162625134)::
0 commit comments