From b8a8c0967a10751e461e3b524867770779f14a66 Mon Sep 17 00:00:00 2001 From: Sravan Balaji Date: Thu, 30 Apr 2020 21:23:02 -0400 Subject: [PATCH] Website Updates - Update ToC - Add links to project resources - Make running container insturctions generic to service - Fix instructions for running semantic code given new repo and docker structure - Fix typo - Add section for particle filter instructions --- docs/home.md | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/docs/home.md b/docs/home.md index 2872d8e..fb703dd 100644 --- a/docs/home.md +++ b/docs/home.md @@ -2,11 +2,15 @@ ## Table of Contents - [Contributors](#contributors) +- [Project Resources](#project-resources) - [Dataset](#dataset) - [Libraries](#libraries) - [Docker](#docker) - [Install & Setup](#install--setup) - [Running Container](#running-container) +- [Documentation](#documentation) + - [Semantic Language Parsing: Chatbot](#semantic-language-parsing-chatbot) + - [Particle Filter](#particle-filter) ## Contributors @@ -24,22 +28,23 @@ - Tzu-Yuan (Justin) Lin ([tzuyuan@umich.edu](mailto:tzuyuan@umich.edu)) - Peter Westra ([pwestra@umich.edu](mailto:pwestra@umich.edu)) +## Project Resources +- [Repository](https://github.com/Mobile-Robotics-W20-Team-9/UMICH-NCLT-SLAP) +- [Video Summary](https://youtu.be/4xinp3mZIP0) +- [Presentation from Video](https://docs.google.com/presentation/d/1PUHZjGNijsOMJ2KPXF_PAGO-eqZTLd085ZuNPc3VSsI/edit?usp=sharing) +- [Generated Models from NCLT Data](https://drive.google.com/drive/folders/1cFf0q76xyul4nbShm-GwDNxFwYh1Bkzx?usp=sharing) + ## Dataset [The University of Michigan North Campus Long-Term Vision and LIDAR Dataset](http://robots.engin.umich.edu/nclt/) ## Libraries -- [OpenCV](https://opencv.org/) -- [Point Cloud Library](http://pointclouds.org/) - [NumPy](https://numpy.org/) - [Scipy](https://www.scipy.org/) - [Matplotlib](https://matplotlib.org/) - [Natural Language Toolkit](https://www.nltk.org/) -- [Cpython](https://pypi.org/project/cPython/) - [NLTK](https://pypi.org/project/nltk/) -- [Setup Tools](https://pypi.org/project/setuptools/) -- [Pylint](https://pypi.org/project/pylint/) - [Spacy](https://pypi.org/project/spacy/) - [Pickle](https://pypi.org/project/pickle-mixin/) - [TensorFlow](https://pypi.org/project/tensorflow/) @@ -55,23 +60,27 @@ For instructions on installing and setting up Docker, see [Getting Started with After cloning the repo, start your docker machine and following commands shown below in your docker terminal. -1. `cd /PATH/TO/UMICH_NCLT_SLAP/src` -2. `docker-compose run --rm python-dev` +1. `cd /PATH/TO/UMICH_NCLT_SLAP/docker` +2. `docker-compose run --rm ` + +## Documentation ### Semantic Language Parsing: Chatbot For standalone testing of the chatbot, run the following commands -1. `cd /PATH/TO/UMICH_NCLT_SLAP/semantic/src` -2. `docker-compose run --rm python-dev` -1. `cd app/semantic` -2. `python gui_chatbot.py` +1. `cd /PATH/TO/UMICH_NCLT_SLAP/docker` +2. `docker-compose run --rm semantic` +3. `cd app/semantic` +4. `python gui_chatbot.py` -You can update the models by changing the intent or pickle files. Intent.json can be changed wiht a basic text editor and pickles can be read and changed using pickleManage.py. -1. `cd /PATH/TO/UMICH_NCLT_SLAP/src/datset/dataManipulation/pickles` +You can update the models by changing the intent or pickle files. Intent.json can be changed with a basic text editor and pickles can be read and changed using pickleManage.py. + +1. `cd /PATH/TO/UMICH_NCLT_SLAP/src/dataset/dataManipulation/pickles` 2. `python` 3. `from pickleManage import *` -4. Use desired functions. Functions are documented with examples in pickleManage.py file. -To update the models are making changes run: -'python +4. Use desired functions. Functions are documented with examples in pickleManage.py file. To update the models are making changes run: `python` +### Particle Filter + + \ No newline at end of file