Skip to content

chore: update Readme for submodules install #472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

chore: update Readme for submodules install #472

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31129a5
chore: update Readme for submodules install
nadinkatrina Aug 17, 2022
82a5bd3
chore: update Readme for contribution
nadinkatrina Aug 17, 2022
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ Then API starts the following procedures:
(which specifies the choice of components in each step and their corresponding hyperparameters.

## Installation
Clone the repository with submodules
```sh

git clone --recurse-submodules git@github.com:automl/Auto-PyTorch.git

```
Comment on lines +47 to +52
Copy link
Contributor

@ravinkohli ravinkohli Aug 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Clone the repository with submodules
```sh
git clone --recurse-submodules git@github.com:automl/Auto-PyTorch.git
```
Copy link
Contributor

@ravinkohli ravinkohli Aug 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add these lines under ## Manual Installation from line no. 71?

### PyPI Installation

Expand All @@ -57,7 +63,7 @@ Auto-PyTorch for Time Series Forecasting requires additional dependencies

```sh

pip install autoPyTorch[forecasting]
pip install 'autoPyTorch[forecasting]'

```

Expand Down Expand Up @@ -207,6 +213,12 @@ If you want to contribute to Auto-PyTorch, clone the repository and checkout our
$ git checkout development
```

### Community Contribution
1. Fork the Repository into your account
2. create a `feature` or `bug` sub-branch e.g. `git checkout -b feature/name_of_feature`
Copy link
Contributor

@ravinkohli ravinkohli Aug 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As stated in line 210, we would like the users to check out new branches from the development branch. I suggest that you unify ## Contributing and ### Community Contribution.
3. Create reasonable commits in your branch
4. Create a Pull Request

## License

This program is free software: you can redistribute it and/or modify
Expand Down