Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some typos in docs #2418

Merged
merged 1 commit into from
Mar 31, 2024
Merged

Conversation

JoshuaLampert
Copy link
Contributor

While browsing through the docs, I found some small typos here and there.

PR Checklist

  • Tests are added
  • Entry in NEWS.md
  • Documentation, if applicable

@CarloLucibello CarloLucibello merged commit d4b94ee into FluxML:master Mar 31, 2024
4 of 8 checks passed
@@ -8,7 +8,7 @@ To introduce Flux's recurrence functionalities, we will consider the following v

In the above, we have a sequence of length 3, where `x1` to `x3` represent the input at each step (could be a timestamp or a word in a sentence), and `y1` to `y3` are their respective outputs.

An aspect to recognize is that in such a model, the recurrent cells `A` all refer to the same structure. What distinguishes it from a simple dense layer is that the cell `A` is fed, in addition to an input `x`, with information from the previous state of the model (hidden state denoted as `h1` & `h2` in the diagram).
An aspect to recognise is that in such a model, the recurrent cells `A` all refer to the same structure. What distinguishes it from a simple dense layer is that the cell `A` is fed, in addition to an input `x`, with information from the previous state of the model (hidden state denoted as `h1` & `h2` in the diagram).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, didn't get around to this in time. In case this comes up again, most of the Flux core team uses the American spelling. Not worth a whole change now, but I wanted to have that known if anyone sees this change and wants to make a similar one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had the impression that mostly British spelling is used (e.g. it is called Optimiser.jl and not Optimizer.jl).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original author was from the UK. Unfortunately we can't change package names so easily, but everything else uses the non-british spelling.

@JoshuaLampert JoshuaLampert deleted the fix-typos-docs branch March 31, 2024 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants