Skip to content

Commit

Permalink
revise README
Browse files Browse the repository at this point in the history
  • Loading branch information
ntuyt committed Dec 7, 2018
1 parent 0121239 commit 53c8380
Showing 1 changed file with 38 additions and 21 deletions.
59 changes: 38 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,49 +25,66 @@ wget http://www.cim.mcgill.ca/dscnn-data/ModelNet40_rendered_rgb.tar; tar -xvf M

without orientation assumption, 20-view settings
```
wget wget https://data.airc.aist.go.jp/kanezaki.asako/data/modelnet40v2png_ori4.tar; tar -xvf modelnet40v2png_ori4.tar
wget https://data.airc.aist.go.jp/kanezaki.asako/data/modelnet40v2png_ori4.tar; tar -xvf modelnet40v2png_ori4.tar
```

End with an example of getting some data out of the system or using it for a little demo
### Download trained models
* [cache_model.tar](https://drive.google.com/open?id=1CB01BrLuPBUCNhq9pDiwIyteUecbN8BO)

## Running the tests
```
tar -xvf cache_model.tar
```

Explain how to run the automated tests for this system
## Training

### Break down into end to end tests
### 6-view ModelNet40
```
python mainalex.py -d modelnet40 -v 6
```

Explain what these tests test and why
### 6-view ModelNet10
```
python mainalex.py -d modelnet10 -v 6
```

### 20-view ModelNet40
```
Give an example
python mainalex.py -d modelnet40 -v 20
```

### And coding style tests
### 20-view ModelNet10
```
python mainalex.py -d modelnet10 -v 20
```

Explain what these tests test and why
## Testing

### 6-view ModelNet40
```
Give an example
python testalex.py -d modelnet40 -v 6 --resume cache_models/
```

## Deployment
### 6-view ModelNet10
```
python testalex.py -d modelnet10 -v 6 --resume cache_models/
```

Add additional notes about how to deploy this on a live system
### 20-view ModelNet40
```
python testalex.py -d modelnet40 -v 20 --resume cache_models/
```

### 20-view ModelNet10
```
python testalex.py -d modelnet10 -v 20 --resume cache_models/
```

## Built With

* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

## Authors

* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
* **Tan YU** - [Homepage](https://sites.google.com/site/tanyuspersonalwebsite/home)

0 comments on commit 53c8380

Please sign in to comment.