Lists and explains the different steps in the compression process (see T1878).
Details
Diff Detail
- Repository
- rDGRPH Compressed graph representation
- Branch
- docs-compression
- Lint
No Linters Available - Unit
No Unit Test Coverage - Build Status
Buildable 6701 Build 9358: arc lint + arc unit
Event Timeline
docs/compression.rst | ||
---|---|---|
7–14 | We should add a reference about BFS-based graph compression. The canonical citation seems to be this one:
| |
15 | I'm missing an introduction of sort here, linking together the references above to the sections below. Ideally we want a dataflow picture here, showing a pipeline of the various phases and which files are produced as byproduct of each phase and which ones are used as input of the next one. Could be an ASCII art, a graphviz-based diagram, or a hand-created diagram (e.g., using draw.io) that is then referenced by the .rst doc. | |
26 | use active voice here (and in general): "we can use" → "we use" | |
40–41 |
| |
53–54 |
| |
59–61 | as many files have been involved during the process, we should list here which (and all) files form the final compressed representation of the graph | |
74 |
|
docs/compression.rst | ||
---|---|---|
74 | Concerning the second point, the class used is already in webgraph unlike the MPH function which is in an external library |
Great graph !
Only a couple of minor things and we'll be there.
docs/compression.rst | ||
---|---|---|
32–36 | This is great, but the other phases are inconsistently documented w.r.t. this one. Can we please have a pointer to the relevant class that implements the transformation in all phase descriptions? | |
docs/images/Makefile | ||
1–9 | Please generate (and clean) also SVG here. I'm guessing for sphinx favors PNG, and allows to do its popup thingie on PNG images, but as the diagram is vectorial, it's nice to also have a non-lossy version of it available. |
docs/compression.rst | ||
---|---|---|
32–36 | The only step where i cannot link to the specific class is the BFS since BFSBig is not yet merged in LAW. |
last one ! :-)
docs/images/Makefile | ||
---|---|---|
12–13 | these should be rm -f, otherwise make clean as a whole can fail if the first file format that make tries to remove is not available on disk |