From b89b48593566fd5e9ce991e98061ea2ab66fe52c Mon Sep 17 00:00:00 2001
From: D-X-Y <280835372@qq.com>
Date: Fri, 17 Jan 2020 16:35:52 +1100
Subject: [PATCH] update README.md
---
.../CODE-OF-CONDUCT.md | 0
CONTRIBUTING.md => .github/CONTRIBUTING.md | 8 ++++----
README.md | 18 +++++++++---------
docs/NAS-Bench-201.md | 2 +-
4 files changed, 14 insertions(+), 14 deletions(-)
rename CODE-OF-CONDUCT.md => .github/CODE-OF-CONDUCT.md (100%)
rename CONTRIBUTING.md => .github/CONTRIBUTING.md (73%)
diff --git a/CODE-OF-CONDUCT.md b/.github/CODE-OF-CONDUCT.md
similarity index 100%
rename from CODE-OF-CONDUCT.md
rename to .github/CODE-OF-CONDUCT.md
diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md
similarity index 73%
rename from CONTRIBUTING.md
rename to .github/CONTRIBUTING.md
index 45211f0..c8077fe 100644
--- a/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,8 +1,8 @@
-# Contributing to NAS-Projects
+# Contributing to AutoDL-Projects
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
-The following is a set of guidelines for contributing to NAS-Projects.
+The following is a set of guidelines for contributing to AutoDL-Projects.
## Table Of Contents
@@ -15,11 +15,11 @@ The following is a set of guidelines for contributing to NAS-Projects.
### Reporting Bugs
-This section guides you through submitting a bug report for NAS-Projects.
+This section guides you through submitting a bug report for AutoDL-Projects.
Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
When you are creating a bug report, please include as many details as possible.
-Fill out [the required template](https://github.com/D-X-Y/NAS-Projects/blob/master/.github/ISSUE_TEMPLATE/bug-report.md). The information it asks for helps us resolve issues faster.
+Fill out [the required template](https://github.com/D-X-Y/AutoDL-Projects/blob/master/.github/ISSUE_TEMPLATE/bug-report.md). The information it asks for helps us resolve issues faster.
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
diff --git a/README.md b/README.md
index 654b92b..a2b3d94 100644
--- a/README.md
+++ b/README.md
@@ -33,22 +33,22 @@ At the moment, this project provides the following algorithms and scripts to run
| NAS |
TAS |
- Network Pruning via Transformable Architecture Search |
+ Network Pruning via Transformable Architecture Search |
NIPS-2019-TAS.md |
| DARTS |
- DARTS: Differentiable Architecture Search |
+ DARTS: Differentiable Architecture Search |
ICLR-2019-DARTS.md |
| GDAS |
- Searching for A Robust Neural Architecture in Four GPU Hours |
+ Searching for A Robust Neural Architecture in Four GPU Hours |
CVPR-2019-GDAS.md |
| SETN |
- One-Shot Neural Architecture Search via Self-Evaluated Template Network |
+ One-Shot Neural Architecture Search via Self-Evaluated Template Network |
ICCV-2019-SETN.md |
@@ -80,8 +80,8 @@ At the moment, this project provides the following algorithms and scripts to run
## History of this repo
At first, this repo is `GDAS`, which is used to reproduce results in Searching for A Robust Neural Architecture in Four GPU Hours.
-After that, more functions and more NAS algorithms are continuely added in this repo. After it supports more than five algorithms, it is upgraded from `GDAS` to `NAS-Project`.
-Now, since both HPO and NAS are supported in this repo, it is upgraded from `NAS-Project` to `AutoDL-Projects`.
+After that, more functions and more NAS algorithms are continuely added in this repo. After it supports more than five algorithms, it is upgraded from `GDAS` to `NAS-Projects`.
+Now, since both HPO and NAS are supported in this repo, it is upgraded from `NAS-Projects` to `AutoDL-Projects`.
## Requirements and Preparation
@@ -125,10 +125,10 @@ If you find that this project helps your research, please consider citing some o
}
```
-## Related Projects
+# Others
-- [Awesome-NAS](https://github.com/D-X-Y/Awesome-NAS) : A curated list of neural architecture search and related resources.
-- [AutoML Freiburg-Hannover](https://www.automl.org/) : A website maintained by Frank Hutter's team, containing many AutoML resources.
+If you want to contribute to this repo, please see [CONTRIBUTING.md](.github/CONTRIBUTING.md).
+Besides, please follow [CODE-OF-CONDUCT.md](.github/CODE-OF-CONDUCT.md).
# License
The entire codebase is under [MIT license](LICENSE.md)
diff --git a/docs/NAS-Bench-201.md b/docs/NAS-Bench-201.md
index b9e4061..8e5eded 100644
--- a/docs/NAS-Bench-201.md
+++ b/docs/NAS-Bench-201.md
@@ -12,7 +12,7 @@ In this Markdown file, we provide:
Note: please use `PyTorch >= 1.2.0` and `Python >= 3.6.0`.
-Simply type `pip install nas-bench-201` to install our api.
+You can simply type `pip install nas-bench-201` to install our api. Please see source codes of `nas-bench-201` module in [this repo](https://github.com/D-X-Y/NAS-Bench-201).
If you have any questions or issues, please post it at [here](https://github.com/D-X-Y/AutoDL-Projects/issues) or email me.