Skip to content

Commit cfe4726

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 92d58d7 commit cfe4726

58 files changed

Lines changed: 209 additions & 314 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ If applicable, add screenshots to help explain your problem.
2828

2929
**Environment (please complete the following information):**
3030

31-
- OS: \[e.g. iOS\]
32-
- Version \[e.g. 22\]
31+
- OS: [e.g. iOS]
32+
- Version [e.g. 22]
3333
- Python version
3434
- Ludwig version
3535

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ assignees: ''
77
---
88

99
**Is your feature request related to a problem? Please describe.**
10-
A clear and concise description of what the problem is. Ex. I'm always frustrated when \[...\]
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1111

1212
**Describe the use case**
1313
A clear and concise description of what the use case for this feature is.

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Work on your self-assigned issue and eventually create a Pull Request.
4949
pip install -e .
5050
```
5151

52-
The above command will install only the packages in "requirements.txt" in the developer mode. If you would like to
52+
The above command will install only the packages in "requirements.txt" in the developer mode. If you would like to
5353
be able to potentially make changes to the overall Ludwig codebase, then use the following command:
5454

5555
```bash
@@ -93,9 +93,9 @@ Work on your self-assigned issue and eventually create a Pull Request.
9393

9494
1. Finally, if during the installation of `horovod`, the exception `ModuleNotFoundError: No module named 'packaging'`
9595
occurs, you may need to disable `horovod` (that means you will need train with another backend, just not `horovod`).
96-
To do that, edit the file `requirements_extra.txt` and comment out the line that begins with `horovod`. After that,
97-
please execute the long `pip install` command given in the previous step. With these work-around provisions, your
98-
installation should run to completion successfully. If you are still having difficulty, please reach out with the
96+
To do that, edit the file `requirements_extra.txt` and comment out the line that begins with `horovod`. After that,
97+
please execute the long `pip install` command given in the previous step. With these work-around provisions, your
98+
installation should run to completion successfully. If you are still having difficulty, please reach out with the
9999
specifics of your environment in the Ludwig Community [Discord](https://discord.gg/CBgdrGnZjy).
100100

101101
1. Develop features on your branch.

README_KR.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ pip install ludwig
6767
[Horovod](https://github.com/horovod/horovod)를 통해 분산 학습이 지원되며, `pip install ludwig[horovod]` 또는 `HOROVOD_GPU_OPERATIONS=NCCL pip install ludwig[horovod]` 와 같이 GPU 환경에서 설치가 가능합니다.
6868
설치 가능한 옵션들을 더 확인하고 싶으시다면 Horovod's [installation guide](https://horovod.readthedocs.io/en/stable/install_include.html) 를 참고하시기 바랍니다.
6969

70-
추가하려는 package들은 `pip install ludwig[extra1,extra2,...]` 의 명령어를 통해 설치가 가능합니다. 예를 들어, `pip install ludwig[text,viz]` 와 같은 조합으로 설치가 가능합니다. 모든 파일들을 한 번에 설치하려면 `pip install ludwig[full]`을 사용하면 됩니다.
70+
추가하려는 package들은 `pip install ludwig[extra1,extra2,...]` 의 명령어를 통해 설치가 가능합니다. 예를 들어, `pip install ludwig[text,viz]` 와 같은 조합으로 설치가 가능합니다. 모든 파일들을 한 번에 설치하려면 `pip install ludwig[full]`을 사용하면 됩니다.
7171

7272
소스코드를 repository에서 build하려는 개발자들은 아래와 같은 방법을 사용하면 됩니다.
7373

examples/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
This directory contains example programs demonstrating Ludwig's Python APIs.
44

5-
| Directory | Examples Provided |
6-
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7-
| hyperopt | Demonstrates Ludwig's to hyper-parameter optimization capability. |
8-
| kfold_cv | Provides two examples for performing a k-fold cross validation analysis. One example uses the `ludwig experiment` cli. The other example uses the `ludwig.experiment.kfold_cross_validate()` api function. |
9-
| mnist | Creates a model config data structure from a yaml file and trains a model. Programmatically modify the model config data structure to evaluate several different neural network architectures. Jupyter notebook demonstrates using a hold-out test data set to visualize model performance for alternative model architectures. |
10-
| titanic | Trains a simple model with model config contained in a yaml file. Trains multiple models from yaml files and generate visualizations to compare training results. Jupyter notebook demonstrating how to programmatically create visualizations. |
11-
| serve | Demonstrates running Ludwig http model server. A sample Python program illustrates how to invoke the REST API to get predictions from input features. |
12-
| class_imbalance | Demonstrates using our class balancing feature to over-sample an imbalanced dataset. |
5+
| Directory | Examples Provided |
6+
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| hyperopt | Demonstrates Ludwig's to hyper-parameter optimization capability. |
8+
| kfold_cv | Provides two examples for performing a k-fold cross validation analysis. One example uses the `ludwig experiment` cli. The other example uses the `ludwig.experiment.kfold_cross_validate()` api function. |
9+
| mnist | Creates a model config data structure from a yaml file and trains a model. Programmatically modify the model config data structure to evaluate several different neural network architectures. Jupyter notebook demonstrates using a hold-out test data set to visualize model performance for alternative model architectures. |
10+
| titanic | Trains a simple model with model config contained in a yaml file. Trains multiple models from yaml files and generate visualizations to compare training results. Jupyter notebook demonstrating how to programmatically create visualizations. |
11+
| serve | Demonstrates running Ludwig http model server. A sample Python program illustrates how to invoke the REST API to get predictions from input features. |
12+
| class_imbalance | Demonstrates using our class balancing feature to over-sample an imbalanced dataset. |

examples/hyperopt/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Demonstrates hyperparameter optimization using Ludwig's in-built capabilities.
55
### Preparatory Steps
66

77
- Create `data` directory
8-
- Download [Kaggle wine quality data set](https://www.kaggle.com/rajyellow46/wine-quality) into the `data` directory. Directory should
8+
- Download [Kaggle wine quality data set](https://www.kaggle.com/rajyellow46/wine-quality) into the `data` directory. Directory should
99
appear as follows:
1010

1111
```

examples/mnist/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This API example is based on [Ludwig's MNIST Hand-written Digit image classifica
44

55
### Examples
66

7-
| File | Description |
8-
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
9-
| simple_model_training.py | Demonstrates using Ludwig api for training a model. |
10-
| advance_model_training.py | Demonstrates a method to assess alternative model architectures. |
11-
| assess_model_performance.py | Assess model performance on hold-out test data set. This shows how to load a previously trained model to make predictions. |
12-
| visualize_model_test_results.ipynb | Example for extracting training statistics and generate custom visualizations. |
7+
| File | Description |
8+
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
9+
| simple_model_training.py | Demonstrates using Ludwig api for training a model. |
10+
| advance_model_training.py | Demonstrates a method to assess alternative model architectures. |
11+
| assess_model_performance.py | Assess model performance on hold-out test data set. This shows how to load a previously trained model to make predictions. |
12+
| visualize_model_test_results.ipynb | Example for extracting training statistics and generate custom visualizations. |

examples/serve/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Ludwig Model Serve Example
22

33
This example shows Ludwig's http model serving capability, which is able to load a pre-trained Ludwig model and respond to REST APIs for predictions.
4-
A simple client program illustrates how to invoke the REST API to retrieve predictions for provided input features. The two REST APIs covered by this example:
4+
A simple client program illustrates how to invoke the REST API to retrieve predictions for provided input features. The two REST APIs covered by this example:
55

66
| REST API | Description |
77
| ---------------- | ------------------------------- |
@@ -27,7 +27,7 @@ examples/
2727
- Open two terminal windows
2828
- In first terminal window:
2929
- Ensure current working directory is `examples/serve`
30-
- Start ludwig model server with the `titanic` trained model. The following command uses the default host address (`0.0.0.0`) and port number (`8000`).
30+
- Start ludwig model server with the `titanic` trained model. The following command uses the default host address (`0.0.0.0`) and port number (`8000`).
3131

3232
```
3333
ludwig serve --model_path ../titanic/results/simple_experiment_simple_model/model

examples/titanic/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ The Titanic dataset is hosted by Kaggle, and as such Ludwig will need to authent
1616
| multiple_model_training.py | Trains two models and generates a visualization for results of training. |
1717
| model_training_results.ipynb | Example for extracting training statistics and generate custom visualizations. |
1818

19-
Enter `python simple_model_training.py` will train a single model. Results of model training will be stored in this location.
19+
Enter `python simple_model_training.py` will train a single model. Results of model training will be stored in this location.
2020

2121
```
2222
./results/
2323
simple_experiment_simple_model/
2424
```
2525

2626
Enter `python multiple_model_training.py` will train two models and generate standard Ludwig visualizations comparing the
27-
two models. Results will in the following directories:
27+
two models. Results will in the following directories:
2828

2929
```
3030
./results/

examples/wine_quality/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Demonstrates how to use Ludwig's defaults section introduced in v0.6.
55
### Preparatory Steps
66

77
- Create `data` directory
8-
- Download [Kaggle wine quality data set](https://www.kaggle.com/rajyellow46/wine-quality) into the `data` directory. Directory should
8+
- Download [Kaggle wine quality data set](https://www.kaggle.com/rajyellow46/wine-quality) into the `data` directory. Directory should
99
appear as follows:
1010

1111
```

0 commit comments

Comments
 (0)