Skip to content

Commit 7b508a0

Browse files
committed
Readme update for package renaming changes
1 parent f63a55b commit 7b508a0

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# SAIL
1+
# AUTOSAIL
22

33
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![main branch](https://github.com/IBM/autosail/actions/workflows/build.yml/badge.svg?branch=main) [![](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/) <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
44

5-
The library is for experimenting with streaming processing engines (SPEs) and incremental machine learning (IML) models. The main features of Sail are:
5+
The library is for experimenting with streaming processing engines (SPEs) and incremental machine learning (IML) models. The main features of AutoSail are:
66

77
- Common interface for all incremental models available in libraries like Scikit-Learn, Pytorch, Keras and River.
88
- Distributed computing for model selection, ensembling etc.
@@ -12,37 +12,37 @@ The library is for experimenting with streaming processing engines (SPEs) and in
1212

1313
## Documentation
1414

15-
See the [**SAIL Wiki**](https://github.com/IBM/autosail/wiki) for full documentation, installation guide, operational details and other information.
15+
See the [**AutoSAIL Wiki**](https://github.com/IBM/autosail/wiki) for full documentation, installation guide, operational details and other information.
1616

1717
## Architecture
1818

19-
### SAIL Pipeline
19+
### AutoSAIL Pipeline
2020

2121
![Architecture](architecture.png)
2222

23-
### SAIL Model Framework
23+
### AutoSAIL Model Framework
2424

2525
![Architecture](model_framework.png)
2626

2727
## Difference with River and other existing incremental machine learning libraries.
2828

29-
Sail leverages the existing machine learning libraries like River, sklearn etc and creates a common set of APIs to run these models in the backend. In particular, while River provides minimal utilities for deep learning models, it does not focus on deep learning models developed through Pytorch and Keras. In addition, models in Sail are parallelized using Ray. The parallelization results in three major advatages that are particularly important for incremental models with high volume and high velocity data:
29+
AutoSAIL leverages the existing machine learning libraries like River, sklearn etc and creates a common set of APIs to run these models in the backend. In particular, while River provides minimal utilities for deep learning models, it does not focus on deep learning models developed through Pytorch and Keras. In addition, models in AutoSAIL are parallelized using Ray. The parallelization results in three major advatages that are particularly important for incremental models with high volume and high velocity data:
3030

3131
- Faster computational times for ensemble models.
3232
- Faster computational times for ensemble of forecasts.
3333
- Creates a clean interface for developing AutoML algorithms for incremental models.
3434

3535
## Spark vs Ray for incremental models.
3636

37-
Sail could have been parallelized using Spark as well. However, to keep the streaming processing engines and machine learning tasks independent, Ray was preferred as the data can then be handled using Pandas, Numpy etc efficiently. This flexibility further allows using other SPEs like Flink or Storm without updating the parallelization framework for IML models.
37+
AutoSAIL could have been parallelized using Spark as well. However, to keep the streaming processing engines and machine learning tasks independent, Ray was preferred as the data can then be handled using Pandas, Numpy etc efficiently. This flexibility further allows using other SPEs like Flink or Storm without updating the parallelization framework for IML models.
3838

3939
## 🛠 Installation
4040

41-
Sail is intended to work with **Python 3.8 and above**. You can install the latest version from GitHub as so:
41+
AutoSAIL is intended to work with **Python 3.8 and above**. You can install the latest version from GitHub as so:
4242

4343
```sh
4444
git clone https://github.com/IBM/autosail.git
45-
cd sail
45+
cd autosail
4646
pip install -e ".[OPTION]"
4747
```
4848

@@ -69,7 +69,7 @@ pip install -e ".[examples]"
6969

7070
## Recognition
7171

72-
SAIL has been identified as innovations with market potential that can contribute to UN Sustainable Development Goals by the European Commission Innovation Radar. More details [here](https://innovation-radar.ec.europa.eu/innovation/46749).
72+
AUTOSAIL has been identified as innovations with market potential that can contribute to UN Sustainable Development Goals by the European Commission Innovation Radar. More details [here](https://innovation-radar.ec.europa.eu/innovation/46749).
7373

7474
## Acknowledgment
7575

0 commit comments

Comments
 (0)