Skip to content

Commit 7655d16

Browse files
committed
[Project] Update readme && add info about examples
1 parent 373b8fb commit 7655d16

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,13 @@ If all requirements are satisfied, run the following command to install PyPI pac
8585
$ python3 -m pip install pycubool
8686
```
8787

88+
### Documentation
89+
90+
The following links give a brief start guide for new users:
91+
92+
- [C API example](https://github.com/JetBrains-Research/cuBool/blob/master/docs/examples/transitive_closure_cpp.md) - complete C++ application to compute transitive closure of an example graph
93+
- [Python API usage](https://github.com/JetBrains-Research/cuBool/blob/master/docs/examples/python_examples.md) - complete and detailed set of the python API usage examples for all lib features
94+
8895
## Getting started
8996

9097
This section gives instructions to build the library from sources.
@@ -106,7 +113,7 @@ These steps are required if you want to build library for your specific platform
106113
> without cuda backend support.
107114
108115
Before the CUDA setup process, validate your system NVIDIA driver with `nvidia-smi`
109-
command. if it is need, install required driver via `ubuntu-drivers devices` and
116+
command. Install required driver via `ubuntu-drivers devices` and
110117
`apt install <driver>` commands respectively.
111118

112119
The following commands grubs the required GCC compilers for the CC and CXX compiling
@@ -294,6 +301,7 @@ cuBool
294301
├── python - pycubool related sources
295302
│ ├── pycubool - cubool library wrapper for python (similar to pygraphblas)
296303
│ ├── tests - regression tests for python wrapper
304+
│ ├── examples - short script files with python api usage examples
297305
│ └── data - generate data for pycubool regression tests
298306
├── deps - project dependencies
299307
│ ├── cub - cuda utility, required for nsparse

docs/examples/python_examples.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Detailed Example
22

3+
The following set of code snippets demonstrates how to use
4+
the **pycubool** package primary primitives, operations and features.
5+
6+
This set contains examples of:
7+
8+
- Matrix manipulation
9+
- Matrix-matrix operations
10+
- Matrix operations
11+
- Debug features
12+
- IO features
13+
14+
These examples require **pycubool** package to installed and the environment properly configured
15+
accordingly to the main [readme](https://github.com/JetBrains-Research/cuBool/blob/master/README.md) document of the project.
16+
317
## Matrix creation example
418
```Python
519
"""

0 commit comments

Comments
 (0)