Skip to content
This repository has been archived by the owner on Jun 3, 2020. It is now read-only.

Commit

Permalink
[readme] consider code review
Browse files Browse the repository at this point in the history
  • Loading branch information
delhomer committed Nov 30, 2018
1 parent d7faac5 commit d2a1ef7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
19 changes: 9 additions & 10 deletions README.md
Expand Up @@ -11,16 +11,15 @@ associated [web application](http://data.oslandia.io/deeposlandia):

# Content

The project contains following folders:
The project contains the following folders:

+ [deeposlandia](./deeposlandia) contains main Python modules to train and test
convolutional neural networks
+ [deeposlandia](./deeposlandia) contains the main Python modules to train and
test convolutional neural networks
+ [examples](./examples) contains some Jupyter notebooks that aim at
describing data or basic neural network construction
describing data and building basic neural networks
+ [images](./images) contains some example images to illustrate the Mapillary
dataset as well as some preprocessing analysis results
+ [tests](./tests) contains some test modules to guarantee the functioning of a
bunch of snippets; it uses the `pytest` framework.
+ [tests](./tests); `pytest` is used to launch several tests from this folder.

Additionally, running the code may generate extra subdirectories in the chosen
data repository.
Expand All @@ -29,9 +28,9 @@ data repository.

## Requirements

The code has been run with Python3. The dependencies are recalled in `setup.py`
file, and additional dependencies for developing purpose are listed in
`requirements-dev.txt`.
The code has been run with Python 3. All dependencies are specified in
`setup.py` file, and additional dependencies for developing purpose are listed
in `requirements-dev.txt`.

## From source

Expand Down Expand Up @@ -73,7 +72,7 @@ depicts a prediction result over the 13-labelled dataset version.

![Example of image, with labels and predictions](./images/mapillary_prediction_example.png)

## AerialImage (INRIA)
## AerialImage (Inria)

In
the
Expand Down
2 changes: 1 addition & 1 deletion deeposlandia/preprocessing.md
Expand Up @@ -22,7 +22,7 @@ For AerialImage dataset, a limited set of image sizes are supported. As smaller
tiles will be generated by cutting the big original image, a divisor of 5000 is
expected.

In the Shapes datase case, this preprocessing step generates a bunch of images
In the shape datase case, this preprocessing step generates a bunch of images
from scratch.

As an easter-egg feature, label popularity is also printed by this command
Expand Down

0 comments on commit d2a1ef7

Please sign in to comment.