|
|
|
At the end of the project, there should be in a git(lab) repository the code used in the
|
|
|
|
project, in an easily runable form. The students should provide documentation on:
|
|
|
|
|
|
|
|
- How to run the code? What software is needed, what version, how to install...
|
|
|
|
- Describing what the different class/module/function do. Especially take care of documenting, non-obvious methods.
|
|
|
|
|
|
|
|
In particular, there should be a README.MD in the repo with the information.
|
|
|
|
|
|
|
|
- If providing jupyter notebooks, they should be self contained and include `pip` commands to install the proper versions.
|
|
|
|
- If providing python scripts, the README.MD should contains the `pip` commands to install the proper versions.
|
|
|
|
- If providing C++/Java/..., there should be a proper build system checking for dependencies.
|
|
|
|
|
|
|
|
Example of README.MD
|
|
|
|
|
|
|
|
```
|
|
|
|
The title of the project
|
|
|
|
========================
|
|
|
|
|
|
|
|
A short description of what the project is about.
|
|
|
|
|
|
|
|
Installation instruction
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
```bash
|
|
|
|
pip install cool_library==1.2.3
|
|
|
|
```
|
|
|
|
|
|
|
|
Files
|
|
|
|
-----
|
|
|
|
|
|
|
|
- _training.ipynb_ a jupyter notebook for the training of our model
|
|
|
|
- _inference.py_ a python script demonstrating how to run the inference of our model
|
|
|
|
|
|
|
|
Running instruction
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
You can start the _inference.py_ script, and then open a web browser at [http://localhost:1020](http://localhost:1020) to run our application.
|
|
|
|
``` |
|
|
\ No newline at end of file |
