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
This commit is contained in:
Sravan Balaji
2020-04-30 21:23:02 -04:00
parent cddc318ddf
commit b8a8c0967a

View File

@@ -2,11 +2,15 @@
## Table of Contents <!-- omit in toc --> ## Table of Contents <!-- omit in toc -->
- [Contributors](#contributors) - [Contributors](#contributors)
- [Project Resources](#project-resources)
- [Dataset](#dataset) - [Dataset](#dataset)
- [Libraries](#libraries) - [Libraries](#libraries)
- [Docker](#docker) - [Docker](#docker)
- [Install & Setup](#install--setup) - [Install & Setup](#install--setup)
- [Running Container](#running-container) - [Running Container](#running-container)
- [Documentation](#documentation)
- [Semantic Language Parsing: Chatbot](#semantic-language-parsing-chatbot)
- [Particle Filter](#particle-filter)
## Contributors ## Contributors
@@ -24,22 +28,23 @@
- Tzu-Yuan (Justin) Lin ([tzuyuan@umich.edu](mailto:tzuyuan@umich.edu)) - Tzu-Yuan (Justin) Lin ([tzuyuan@umich.edu](mailto:tzuyuan@umich.edu))
- Peter Westra ([pwestra@umich.edu](mailto:pwestra@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 ## Dataset
[The University of Michigan North Campus Long-Term Vision and LIDAR Dataset](http://robots.engin.umich.edu/nclt/) [The University of Michigan North Campus Long-Term Vision and LIDAR Dataset](http://robots.engin.umich.edu/nclt/)
## Libraries ## Libraries
- [OpenCV](https://opencv.org/)
- [Point Cloud Library](http://pointclouds.org/)
- [NumPy](https://numpy.org/) - [NumPy](https://numpy.org/)
- [Scipy](https://www.scipy.org/) - [Scipy](https://www.scipy.org/)
- [Matplotlib](https://matplotlib.org/) - [Matplotlib](https://matplotlib.org/)
- [Natural Language Toolkit](https://www.nltk.org/) - [Natural Language Toolkit](https://www.nltk.org/)
- [Cpython](https://pypi.org/project/cPython/)
- [NLTK](https://pypi.org/project/nltk/) - [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/) - [Spacy](https://pypi.org/project/spacy/)
- [Pickle](https://pypi.org/project/pickle-mixin/) - [Pickle](https://pypi.org/project/pickle-mixin/)
- [TensorFlow](https://pypi.org/project/tensorflow/) - [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. 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` 1. `cd /PATH/TO/UMICH_NCLT_SLAP/docker`
2. `docker-compose run --rm python-dev` 2. `docker-compose run --rm <service>`
## Documentation
### Semantic Language Parsing: Chatbot ### Semantic Language Parsing: Chatbot
For standalone testing of the chatbot, run the following commands For standalone testing of the chatbot, run the following commands
1. `cd /PATH/TO/UMICH_NCLT_SLAP/semantic/src` 1. `cd /PATH/TO/UMICH_NCLT_SLAP/docker`
2. `docker-compose run --rm python-dev` 2. `docker-compose run --rm semantic`
1. `cd app/semantic` 3. `cd app/semantic`
2. `python gui_chatbot.py` 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. 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/datset/dataManipulation/pickles`
1. `cd /PATH/TO/UMICH_NCLT_SLAP/src/dataset/dataManipulation/pickles`
2. `python` 2. `python`
3. `from pickleManage import *` 3. `from pickleManage import *`
4. Use desired functions. Functions are documented with examples in pickleManage.py file. 4. Use desired functions. Functions are documented with examples in pickleManage.py file. To update the models are making changes run: `python`
To update the models are making changes run:
'python
### Particle Filter
<!-- TODO: Add instructions for running particle filter code -->