Skip to content

Commit

Permalink
Fixed typos
Browse files Browse the repository at this point in the history
  • Loading branch information
hschilling committed May 28, 2022
1 parent 6fa8ecd commit 247563f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Useful documentation on torch data object
**Unprocessed dataset** can be found at https://nasa-public-data.s3.amazonaws.com/plot3d_utilities/airfoil-learning-dataset.zip
This dataset is not normalized and contains the geometry of each airfoil and the xfoil results. It's important to go through the process of normalizing the design. This will give you the scalars (scalers.pickle) used with the processed dataset. See tutorial (Normalization section).

> Important note: Training can give you really low values for error and loss but all of that doesn't mean much until you do a santity check with a random design. You may find low error but a mistake in your normalization/unnormalization code will give you strange results and most definitely affects the training. Always do a santiy check and plot what it is you are interested in.
> Important note: Training can give you really low values for error and loss but all of that doesn't mean much until you do a sanity check with a random design. You may find low error but a mistake in your normalization/unnormalization code will give you strange results and most definitely affects the training. Always do a sanity check and plot what it is you are interested in.
**Processed and normalized dataset**: https://nasa-public-data.s3.amazonaws.com/plot3d_utilities/dataset-processed.zip

Expand All @@ -40,7 +40,7 @@ This tutorial link covers which codes to run to setup the dataset and proceed wi

Jupyter notebook is great from demonstrations, homework, interview questions, but it should never be used for real development work. I have witnessed interns who do development work in Jupyter because they do not know how to debug python with vscode, pycharm, or any editor. Their notebooks are massive 1000+ lines of code and output. They broke something in cell 20, ended up fixing it in cell 50 and when they run through the code from start to finish it's broken from cell 21 to 49. Weeks go by and still they couldn't figure it out. End of internship and the notebook is still broken. Notebooks are never mean for code development, only for show and tell.

For python development, I reccomend the following:
For python development, I recommend the following:
- Visual studio code
- Extensions:
- autodocstring
Expand All @@ -61,7 +61,7 @@ To report bugs, add a github issue. Instructions for adding github issues: [How
## Repository Walk through
Below are links to two interactive walk throughs detailing how to reproduce the results of this work.
1. Generating Airfoil Designs [Generate Xfoil](https://github.com/nasa/airfoil-learning/tree/main/generate_xfoil)
2. Training Graph Netwworks and MultiLayer Perception (MLP) [pytorch](https://github.com/nasa/airfoil-learning/tree/main/pytorch)
2. Training Graph Networks and MultiLayer Perception (MLP) [pytorch](https://github.com/nasa/airfoil-learning/tree/main/pytorch)

## Technical Reports
A link to the publication will be included here once it's been published.
Expand Down

0 comments on commit 247563f

Please sign in to comment.