@@ -10,6 +10,7 @@ Many thanks to all existing and future contributors for their participation.
10
10
11
11
## Workflow
12
12
The typical workflow for ` pygrank ` contributions comprises the following steps:
13
+
13
14
1 . ** Fork** the master branch from the GitHub repository.
14
15
2 . ** Clone** the fork locally (recommended: also copy the * pre-commit* file to * .git/hooks* ).
15
16
3 . ** Edit** the library.
@@ -22,8 +23,8 @@ such as conda or venv (provided by PyCharm).
22
23
The environment should come with Python 3.9 or later installed.
23
24
Make sure that both base library dependencies
24
25
` networkx ` , ` numpy ` , ` scipy ` , ` sklearn ` (scikit-learn), ` wget ` ,
25
- as well as ` tensorflow ` , ` torch ` , ` matvec ` , ` torch-sparse `
26
- (the last three needed support
26
+ as well as ` tensorflow ` , ` torch ` , ` matvec ` , ` torch-sparse ` , ` dask[distributed] `
27
+ (the last five are needed support
27
28
unit testing for the respective backends)
28
29
are installed and upgraded to their latest versions.
29
30
@@ -80,7 +81,7 @@ in the same module you can safely import classes from `pygrank.measures`.
80
81
** Which classes to subclass?**
81
82
82
83
To create a new node ranking algorithm, you are required to subclass one of the
83
- classes found in ` pygrank.algorithms.filters.abstract_filters ` :
84
+ classes found in ` pygrank.algorithms.filters.abstract ` :
84
85
* ` GraphFilter ` identifies generic graph filters (is subclassed by the next two)
85
86
* ` RecursiveGraphFilter ` identifies graph filters that can be described with a recursive formula
86
87
* ` ClosedFormGraphFilter ` identifies graph filers that can be described in closed form
0 commit comments