Skip to content

Commit 31caf52

Browse files
authored
✨ 🚀 ✨ [Docs] Update README
1 parent afd9a26 commit 31caf52

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,28 @@ experimental analysis of Context-Free Path Querying algorithms.
2828
- **Documentation:** https://jetbrains-research.github.io/CFPQ_Data/reference/index.html
2929
- **Source Code:** https://github.com/JetBrains-Research/CFPQ_Data
3030
- **Bug Tracker:** https://github.com/JetBrains-Research/CFPQ_Data/issues
31+
32+
Examples
33+
********
34+
35+
Dataset content
36+
---------------
37+
38+
.. code-block:: python
39+
40+
>>> import cfpq_data
41+
>>> cfpq_data.DATASET
42+
['skos', 'wc', 'generations', 'travel', 'univ', 'atom', 'biomedical', 'bzip', 'foaf', 'people', 'pr', 'funding', 'ls', 'wine', 'pizza', 'gzip', 'core', 'pathways', 'enzyme', 'eclass', 'go_hierarchy', 'go', 'apache', 'init', 'mm', 'geospecies', 'ipc', 'lib', 'block', 'arch', 'crypto', 'security', 'sound', 'net', 'fs', 'drivers', 'postgre', 'kernel', 'taxonomy', 'taxonomy_hierarchy']
43+
44+
Load graph from Dataset
45+
-----------------------
46+
47+
.. code-block:: python
48+
49+
>>> bzip_path = cfpq_data.download("bzip")
50+
>>> bzip = cfpq_data.graph_from_csv(bzip_path)
51+
52+
How to add a new graph?
53+
***********************
54+
55+
Just create a PR (Pull Request) corresponding to the `"Template for adding a new graph" <https://github.com/JetBrains-Research/CFPQ_Data/blob/master/.github/PULL_REQUEST_TEMPLATE/new_graph.md>`_.

0 commit comments

Comments
 (0)