From bd997311478a1dcb8faf628849269e894fe53144 Mon Sep 17 00:00:00 2001 From: Olivier Boulant Date: Thu, 25 Nov 2021 11:20:09 +0100 Subject: [PATCH 1/3] add reference to the python wrapper and introduce tests --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index cbbe323..c52ca29 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,19 @@ 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. +### Use the Python wrapper + +We created a python wrapper of the present implementation. It brings : + +* The benefit of Python flexibility in terms of formating input data, +* The benefit of C speed implementation. + +You can find the Python wrapper here : [https://github.com/oboulant/tamis](https://github.com/oboulant/tamis). + ## Tests +We implemented unit tests using [Infer](https://fbinfer.com/docs/getting-started/). You can compile and run those tests using the following instructions. + ### Clean and Compile ``` From 1251bd127fd04d811fa7f0d544872b7b0b050069 Mon Sep 17 00:00:00 2001 From: Olivier Boulant Date: Thu, 25 Nov 2021 11:27:13 +0100 Subject: [PATCH 2/3] small rearrangement --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c52ca29..bdb093f 100644 --- a/README.md +++ b/README.md @@ -36,15 +36,14 @@ 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. -### Use the Python wrapper +## Run on your own data : Use the Python wrapper -We created a python wrapper of the present implementation. It brings : +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. -You can find the Python wrapper here : [https://github.com/oboulant/tamis](https://github.com/oboulant/tamis). - ## Tests We implemented unit tests using [Infer](https://fbinfer.com/docs/getting-started/). You can compile and run those tests using the following instructions. From 9267ebbc9624820b5dcd917590539b3a4d2ea176 Mon Sep 17 00:00:00 2001 From: Olivier Boulant Date: Fri, 26 Nov 2021 11:09:49 +0100 Subject: [PATCH 3/3] typo Infer <> Unity and add section for Infer --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bdb093f..1ba75a1 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ It brings : ## Tests -We implemented unit tests using [Infer](https://fbinfer.com/docs/getting-started/). You can compile and run those tests using the following instructions. +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 @@ -60,3 +60,6 @@ We implemented unit tests using [Infer](https://fbinfer.com/docs/getting-started > ./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. \ No newline at end of file