Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add reference to the python wrapper and introduce tests #9

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add reference to the python wrapper and introduce tests #9

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd99731
add reference to the python wrapper and introduce tests
oboulant Nov 25, 2021
1251bd1
small rearrangement
oboulant Nov 25, 2021
9267ebb
typo Infer <> Unity and add section for Infer
oboulant Nov 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,18 @@ If you want to change input data file, please
* edit `./examples/main.c` with the proper file path,
* change `nb_lines` and `nb_cols` in accordance with you data.

## Run on your own data : Use the Python wrapper

If you want to use the present implementation on your own data, the easiest way is to use our Python wrapper. It can be found here : [https://github.com/oboulant/tamis](https://github.com/oboulant/tamis).
It brings :

* The benefit of Python flexibility in terms of formating input data,
* The benefit of C speed implementation.

## Tests

We implemented unit tests using [Unity](https://github.com/ThrowTheSwitch/Unity). You can compile and run those tests using the following instructions.

### Clean and Compile

```
Expand All @@ -50,3 +60,6 @@ If you want to change input data file, please
> ./test
```

### Infer

We also made a run local runs (not integrated within the CI) [Infer](https://fbinfer.com/docs/getting-started/) in order to check that there was no memory management errors.