From e128d483ca70a605263d0632c550733f9dd53c36 Mon Sep 17 00:00:00 2001
From: HuguesTHOMAS <huguesthomas218@gmail.com>
Date: Tue, 31 Mar 2020 15:56:08 -0400
Subject: [PATCH] Initial commit

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..210af0a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+
+![Intro figure](https://github.com/HuguesTHOMAS/KPConv/blob/master/doc/Github_intro.png)
+
+Created by Hugues THOMAS
+
+## Introduction
+
+This repository contains the implementation of **Kernel Point Convolution** (KPConv) in PyTorch. *[Work in progress]*
+
+KPConv is also available in [Tensorflow](https://github.com/HuguesTHOMAS/KPConv) (original implementation)
+ 
+KPConv is a point convolution operator presented in our ICCV2019 paper ([arXiv](https://arxiv.org/abs/1904.08889)). If you find our work useful in your 
+research, please consider citing:
+
+```
+@article{thomas2019KPConv,
+    Author = {Thomas, Hugues and Qi, Charles R. and Deschaud, Jean-Emmanuel and Marcotegui, Beatriz and Goulette, Fran{\c{c}}ois and Guibas, Leonidas J.},
+    Title = {KPConv: Flexible and Deformable Convolution for Point Clouds},
+    Journal = {Proceedings of the IEEE International Conference on Computer Vision},
+    Year = {2019}
+}
+```
+
+## Installation
+
+TODO
+
+## Experiments
+
+Currently only two experiments are available in Pytorch: classification on ModelNet40 and segmentation on S3DIS.
+
+TODO: Guide for runnig experiments
+TODO: More experiments
+
+## Acknowledgment
+
+Our code uses the <a href="https://github.com/jlblancoc/nanoflann">nanoflann</a> library.
+
+## License
+Our code is released under MIT License (see LICENSE file for details).
+
+## Updates
+* 31/03/2020: Initial release.