Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Commit ff4ffc6

Browse files
committed
automatic deploy
1 parent 9255d91 commit ff4ffc6

46 files changed

Lines changed: 2493 additions & 3065 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_sources/installation.rst.txt

Lines changed: 3 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,8 @@
22
Installation
33
============
44

5-
Graphbrain requires Python >=3.9 and runs on macOS, Linux and Windows.
5+
Graphbrain requires Python >=3.10.
66

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>`_.
117

128
Install with pip
139
================
@@ -52,16 +48,6 @@ In case both models are present, Graphbrain will use the transformer model. A sp
5248

5349
$ pip uninstall en_core_web_trf
5450

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::
59-
60-
pip install https://github.com/explosion/spacy-experimental/releases/download/v0.6.1/en_coreference_web_trf-3.4.0a2-py3-none-any.whl
61-
62-
63-
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-
6551
Install from the code repository (github)
6652
=========================================
6753

@@ -75,10 +61,6 @@ Start by cloning the source code to your current local directory.
7561

7662
It is advisable to work with virtual environments, for reasons that are explained in the previous section. Please refer to it for details.
7763

78-
Install Cython::
79-
80-
$ pip install cython
81-
8264
Now you can build and install graphbrain::
8365

8466
$ pip install .
@@ -89,7 +71,7 @@ If you are working on graphbrain development or wish to modify the code for your
8971

9072
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.
9173

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.
9375

9476
For developers
9577
--------------
@@ -103,9 +85,8 @@ Run tests
10385

10486
From the project's root directory::
10587

106-
$ pytest graphbrain
88+
$ pytest
10789

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.
10990

11091
Prerequisites
11192
=============
@@ -145,18 +126,3 @@ If python 3 is not already included with your current version os macOS::
145126
* virtualenv (Virtual Python Environment builder)::
146127

147128
$ sudo -H pip install virtualenv
148-
149-
* LevelDB version 1.22
150-
151-
This version of LevelDB is no longer supported by Homebrew, but it is possible to install it using a custom formula that we provide::
152-
153-
$ brew tap graphbrain/homebrew-formulae git@github.com:graphbrain/homebrew-formulae.git
154-
$ brew extract --version=1.22 leveldb graphbrain/formulae
155-
$ brew install leveldb@1.22
156-
157-
(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)::
160-
161-
$ export LIBRARY_PATH="$LIBRARY_PATH:$(brew --prefix)/lib"
162-
$ export CPATH="$CPATH:$(brew --prefix)/include"

0 commit comments

Comments
 (0)