Skip to content

Commit 9f52241

Browse files
authored
Merge pull request #8 from IsolationKernel/develop
docs
2 parents 2404149 + 9fa4392 commit 9f52241

File tree

3 files changed

+12
-25
lines changed

3 files changed

+12
-25
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,19 +147,19 @@ clf.predict([[0.1, 0.3], [0, 0.7], [90, 85]])
147147

148148
## Features
149149

150-
ikpykit provides a set of key features designed to make time series forecasting with machine learning easy and efficient. For a detailed overview, see the [User Guides](https://isolationkernel.github.io/ikpykit/user_guides/table-of-contents.html).
150+
IKPyKit provides a set of key features designed to make machine learning tasks easy and efficient. For a detailed overview, see the [User Guides](https://isolationkernel.github.io/ikpykit/user_guides/table-of-contents.html).
151151

152152
---
153153

154154
## Examples and tutorials
155155

156-
Explore our extensive list of examples and tutorials (English and Spanish) to get you started with ikpykit. You can find them [here](https://isolationkernel.github.io/ikpykit/examples/examples_english.html).
156+
Explore our extensive list of examples and tutorials to get you started with IKPyKit. You can find them [here](https://isolationkernel.github.io/ikpykit/examples/examples_english.html).
157157

158158
---
159159

160160
## How to contribute
161161

162-
Primarily, ikpykit development consists of adding and creating new *Forecasters*, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:
162+
Primarily, IKPyKit development consists of adding and creating new algorithms, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:
163163

164164
- Submit a bug report or feature request on [GitHub Issues](https://github.com/IsolationKernel/ikpykit/issues).
165165
- Contribute a Jupyter notebook to our [examples](https://isolationkernel.github.io/ikpykit/examples/examples_english.html).
@@ -168,15 +168,15 @@ Primarily, ikpykit development consists of adding and creating new *Forecasters*
168168
- Translate our documentation into another language.
169169
- Write a blog post, tweet, or share our project with others.
170170

171-
For more information on how to contribute to ikpykit, see our [Contribution Guide](https://isolationkernel.github.io/ikpykit/contributing/contribution.html).
171+
For more information on how to contribute to IKPyKit, see our [Contribution Guide](https://isolationkernel.github.io/ikpykit/contributing/contribution.html).
172172

173-
Visit our [authors section](https://isolationkernel.github.io/ikpykit/authors/authors.html) to meet all the contributors to ikpykit.
173+
Visit our [authors section](https://isolationkernel.github.io/ikpykit/authors/authors.html) to meet all the contributors to IKPyKit.
174174

175175
---
176176

177177
## Citation
178178

179-
If you use ikpykit for a scientific publication, we would appreciate citations to the published software.
179+
If you use IKPyKit for a scientific publication, we would appreciate citations to the published software.
180180

181181
**BibTeX**:
182182

docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,19 +147,19 @@ clf.predict([[0.1, 0.3], [0, 0.7], [90, 85]])
147147

148148
## Features
149149

150-
ikpykit provides a set of key features designed to make time series forecasting with machine learning easy and efficient. For a detailed overview, see the [User Guides](./user_guides/table-of-contents.html).
150+
IKPyKit provides a set of key features designed to make machine learning tasks easy and efficient. For a detailed overview, see the [User Guides](./user_guides/table-of-contents.html).
151151

152152
---
153153

154154
## Examples and tutorials
155155

156-
Explore our extensive list of examples and tutorials (English and Spanish) to get you started with ikpykit. You can find them [here](./examples/examples_english.html).
156+
Explore our extensive list of examples and tutorials to get you started with IKPyKit. You can find them [here](./examples/examples_english.html).
157157

158158
---
159159

160160
## How to contribute
161161

162-
Primarily, ikpykit development consists of adding and creating new *Forecasters*, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:
162+
Primarily, IKPyKit development consists of adding and creating new algorithms, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:
163163

164164
- Submit a bug report or feature request on [GitHub Issues](https://github.com/IsolationKernel/ikpykit/issues).
165165
- Contribute a Jupyter notebook to our [examples](./examples/examples_english.html).
@@ -168,15 +168,15 @@ Primarily, ikpykit development consists of adding and creating new *Forecasters*
168168
- Translate our documentation into another language.
169169
- Write a blog post, tweet, or share our project with others.
170170

171-
For more information on how to contribute to ikpykit, see our [Contribution Guide](./contributing/contribution.html).
171+
For more information on how to contribute to IKPyKit, see our [Contribution Guide](./contributing/contribution.html).
172172

173-
Visit our [authors section](./authors/authors.html) to meet all the contributors to ikpykit.
173+
Visit our [authors section](./authors/authors.html) to meet all the contributors to IKPyKit.
174174

175175
---
176176

177177
## Citation
178178

179-
If you use ikpykit for a scientific publication, we would appreciate citations to the published software.
179+
If you use IKPyKit for a scientific publication, we would appreciate citations to the published software.
180180

181181
**BibTeX**:
182182

docs/quick-start/how-to-install.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,6 @@ Latest (unstable):
1919
pip install git+https://github.com/IsolationKernel/ikpykit.git@main --upgrade
2020
```
2121

22-
Alternatively download the package, install requirements, and manually run the installer:
23-
24-
```bash
25-
wget https://github.com/IsolationKernel/ikpykit.git@main
26-
unzip ikpykit-main.zip
27-
rm ikpyikt-main.zip
28-
cd ikpykit-main
29-
30-
pip install -r requirements.txt
31-
32-
python setup.py install
33-
```
34-
3522
Once the installation is completed, you can check whether the installation was successful through:
3623

3724
```py

0 commit comments

Comments
 (0)