Skip to content

Commit

Permalink
Merge pull request #91 from madratman/PR/qualifier_round_readme_update
Browse files Browse the repository at this point in the history
add note for disabled aim APIs
  • Loading branch information
madratman authored Oct 17, 2019
2 parents a941dc6 + bbc217a commit 8bbb60a
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,19 @@
- Download training environments (shipped in pakfiles) - `Soccer_Field.pak`, `ZhangJiaJie.pak`, and `Building99.pak`.
- Move the environment pakfiles into `AirSim/AirSimExe/Content/Paks`.

Note:
Notes:
- `Source code (zip)` or `Source code (tar.gz)` might not be up-to-date with the master branch of this repository. It can be lagging by `n commits to master since this release`, specified on the released page.
For the code on this repository, it's best to just `git clone`.

- List of disabled APIs in qualification binaries: The following APIs on the server side in the qualification binaries. You should see an error message pop up in the terminal message when you call these. They do work in the training binaries:
- `simSetObjectPose`
- `simSetVehiclePose`
- `simSetObjectScale`
- `simGetObjectScale`
- `simSetSegmentationObjectID`
- `simGetSegmentationObjectID`
- `simPause`
- `simContinueForTime`

#### Running
- Linux
Expand Down Expand Up @@ -104,7 +113,7 @@ It's ok to make a submission for as little as a single track and/or a single tie
You can find race logs inside of `AirSimExe/Saved/Logs/RaceLogs` in your downloaded binary folder.
Please read [the race monitoring section](https://github.com/microsoft/AirSim-NeurIPS2019-Drone-Racing/blob/master/docs/competition_guidelines.md#race-monitoring) in the competition guidelines for more details.
- The leaderboard will publish the results of a drone that is named `drone_1` (call [`generate_settings_file.py`](https://github.com/microsoft/AirSim-NeurIPS2019-Drone-Racing/blob/master/baselines/generate_settings_file.py) to generate an AirSim settings file, as done for the `baseline_racer` below.
- Please submit a PDF file in the `report` section to help us verify the honesty of your submission for the Nov 21st deadline.
- Please submit a PDF file in the `report` section to help us verify the honesty of your submission for the Nov 21st deadline. Please summarize your approach for all tiers you make a submission for, with appropriate citations. The report PDF size should not exceed 10 MB, and should be a maximum of 4 pages in length. We leave the exact format of the report to your descrition, but the [IEEE template](https://ras.papercept.net/conferences/support/tex.php) is a good choice.
- We have emailed you a private key, which should be entered in the `Team ID` field. This helps us verify it was your team who indeed made the submission.
- The [leaderboard](https://microsoft.github.io/AirSim-NeurIPS2019-Drone-Racing/leaderboard.html) is updated once per day at 2100 PST.
If you do not see your results after 24 hours, please [email us](mailto:neuripsdronecontestinfo@gmail.com) with your team name and submitted log files.
Expand Down Expand Up @@ -161,4 +170,4 @@ Please read [the race monitoring section](https://github.com/microsoft/AirSim-Ne
- Click your desired level. (Note: the UI lists all the pakfiles in the `AirSim/AirSimExe/Content/Paks` directory. Ensure you downloaded the pakfile, if you are not able to see a particular environment)

## Questions
Please open a Github Issue on **this** repository (not [AirSim](https://github.com/microsoft/AirSim)) for any technical questions w.r.t. the Neurips competition.
Please open a Github Issue on **this** repository (not [AirSim](https://github.com/microsoft/AirSim)) for any technical questions w.r.t. the Neurips competition.

0 comments on commit 8bbb60a

Please sign in to comment.