|
1 | | -Welcome to the contributing guidelines of torchensemble! |
| 1 | +Welcome to the contributing guidelines of Ensemble-Pytorch! |
2 | 2 |
|
3 | | -torchensemble is a community-driven project and your contributions are highly welcome. Feel free to [raise an issue](https://github.com/TorchEnsemble-Community/Ensemble-Pytorch/issues/new/choose) if you have any problem. |
| 3 | +Ensemble-Pytorch is a community-driven project and your contributions are highly welcome. Feel free to [raise an issue](https://github.com/TorchEnsemble-Community/Ensemble-Pytorch/issues/new/choose) if you have any problem. Below is the table of contents in this contributing guidelines. |
4 | 4 |
|
5 | 5 | - [Where to contribute](#where-to-contribute) |
6 | 6 | - [Areas of contribution](#areas-of-contribution) |
@@ -48,7 +48,7 @@ If we have missed anything, please [raise an issue](https://github.com/TorchEnse |
48 | 48 | Installation |
49 | 49 | ------------ |
50 | 50 |
|
51 | | -Please visit our [installation instructions](https://ensemble-pytorch.readthedocs.io/en/stable/quick_start.html#installation) to resolve any package issues and dependency errors before they occur in the following steps. |
| 51 | +Please visit our [installation instructions](https://ensemble-pytorch.readthedocs.io/en/stable/quick_start.html#installation) to resolve any package issues and dependency errors. Feel free to [raise an issue](https://github.com/TorchEnsemble-Community/Ensemble-Pytorch/issues/new/choose) if the problem still exists. |
52 | 52 |
|
53 | 53 | Reporting bugs |
54 | 54 | -------------- |
@@ -107,7 +107,7 @@ flake8 --filename=*.py torchensemble/ |
107 | 107 | API design |
108 | 108 | ---------- |
109 | 109 |
|
110 | | -The general API design we follow in torchensemble is similar to [scikit-learn](https://scikit-learn.org/) and [skorch](https://skorch.readthedocs.io/en/latest/?badge=latest). |
| 110 | +The general API design we use in torchensemble is similar to [scikit-learn](https://scikit-learn.org/) and [skorch](https://skorch.readthedocs.io/en/latest/?badge=latest). |
111 | 111 |
|
112 | 112 | For docstrings, we use the [numpy docstring standard](https://numpydoc.readthedocs.io/en/latest/format.html\#docstring-standard). |
113 | 113 |
|
@@ -138,4 +138,4 @@ You can find the generated files in the `Ensemble-Pytorch/docs/_build/` folder. |
138 | 138 | Acknowledgement |
139 | 139 | --------------- |
140 | 140 |
|
141 | | -This CONTRIBUTING is adapted from the [PyTorch](https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md) and [Sktime](https://github.com/alan-turing-institute/sktime/blob/main/CONTRIBUTING.md). |
| 141 | +This CONTRIBUTING file is adapted from the [PyTorch](https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md) and [Sktime](https://github.com/alan-turing-institute/sktime/blob/main/CONTRIBUTING.md). |
0 commit comments