diff --git a/README.md b/README.md index 9daee52..a6636de 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,48 @@ # TensorBird A project aiming to perform auto identification of bird species from pictures taken by [PiCameraTrap](https://forge.ortion.xyz/UncleSamulus/PiCameraTrap) -using machine learning +using machine learning. ## Inspiration I have been inprired by following ressource : * [darenjhsu birdid repository](https://github.com/darrenjhsu/birdid) + + +## Environmnent Set Up + +### Create and Activate virtual env + +```bash +python -m venv tb-venv +source tb-venv/bin/activate +``` + +### Install Tensorflow in container + +```bash +docker pull tensorflow/tensorflow:latest # Download latest stable image +docker run -it -p 8888:8888 tensorflow/tensorflow:latest-jupyter # Start Jupyter server +``` + +### Install Tensorflow using pip + +```bash +python -m pip install tensorflow +``` + +### Launch Jupyter Notebook + +#### Make the virtual env accessible from Jupyter Notebook + +```bash +pip install ipykernel +python -m ipykernel install --user --name=tb-venv +``` + +#### Launch Jupyter + +```bash +jupyter notebook +``` +