Skip to content

Commit ed7e417

Browse files
committed
update readme
1 parent 9b359f7 commit ed7e417

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,12 @@
22

33
## Summary
44

5-
**PTMLib** is a set of utilities that I have used with Machine Learning frameworks such as Scikit-Learn and TensorFlow. The purpose is to eliminate code that I kept repeating in multiple projects.
5+
**PTMLib** is a set of utilities for use with Machine Learning frameworks such as Scikit-Learn and TensorFlow.
66

77
- **ptmlib.time.Stopwatch** - measure the time it takes to complete a long-running task, with an audio alert for task completion
88
- **ptmlib.cpu.CpuCount** - get info on CPUs available, with options to adjust/exclude based on a specific number/percentage. Useful for setting `n_jobs` in Scikit-Learn tools that support multiple CPUs, such as `RandomForestClassifier`
9-
- **ptmlib.charts** - render separate line charts for TensorFlow accuracy and loss, with corresponding validation data if available
10-
- **ptmlib.model_tools.load_or_fit_model()** - save and reload Tensorflow models and training graphs automatically, making it easier to pick up where you left off
11-
12-
*This code and documentation were created by Andre Oporto at [Pendragon AI](https://www.pendragonai.com)*
9+
- **ptmlib.charts** - render separate line charts for TensorFlow metrics such as accuracy and loss, with corresponding validation data if available
10+
- **ptmlib.model_tools.load_or_fit_model()** - train, save, and reload Tensorflow models and metric charts automatically, making it easier to pick up where you left off
1311

1412
## ptmlib.time.Stopwatch
1513

@@ -138,7 +136,7 @@ The default file name format for these images is *searchstring-timestamp.png*.
138136

139137
## ptmlib.model_tools.load_or_fit_model()
140138

141-
The `ptmlib.model_tools.load_or_fit_model()` function makes it easy to train and save a model for later use, in cases where you may need to stop and restart work in Jupyter or your IDE. This can be very helpful when working through a long and detailed notebook, where some models take significant time to train. You can avoid repeatedly training models you are satisfied with and have completed, and still close and reopen your notebook as needed.
139+
The `ptmlib.model_tools.load_or_fit_model()` function makes it easy to train and save a model for later use, in cases where you may need to stop and restart work in Jupyter or your IDE *after* model training has completed. This can be very helpful when working through a long and detailed notebook with multiple example models, where some models take significant time to train. You can avoid repeatedly training models you are satisfied with and have completed, and still close and reopen your notebook as needed.
142140

143141
### Example Usage:
144142

@@ -170,7 +168,7 @@ You will see output similar to the following if you re-run a previously saved no
170168

171169
![Sample load_or_fit_model Screenshot](ptmlib/media/load_or_fit_model_screenshot.png)
172170

173-
If you wish to retrain a model that has previously been saved, simply delete to saved model and related images, which are stored as `h5` and `png` files respectively.
171+
If you wish to retrain a model that has previously been saved, simply delete the model file and related images, which are stored as `h5` and `png` files respectively.
174172

175173
## Installation
176174

0 commit comments

Comments
 (0)