-
-
Notifications
You must be signed in to change notification settings - Fork 21
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
Fixing grammatical mistakes, typos, and adding description to the Viterbi algorithm #38
base: main
Are you sure you want to change the base?
Conversation
- On the other hand, write generic code where appropriate. Do not impose arbitrary limitations if the code can work on a wider range of data types. | ||
- Don't use unsigned numerical types (`uint` and its sized variants), unless wrapping behaviour or binary manipulation is required for the algorithm. | ||
- Don't use unsigned numerical types (`uint` and its sized variants), unless wrapping behavior or binary manipulation is required for the algorithm. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an international collaboration, so enforcing US spelling in docs is debatable (for symbols it's ok due to tradition).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had I to choose, I would prefer UK spelling and grammar rules. US spelling/grammar feels omnipresent.
As a French speaker, I often mix US/UK usages. Usually, I use Grammarly to help me correct my syntax, but I did not use it for writing the CONTRIBUTING.md file.
Thanks a lot for the fixes, receiving a human read-through is invaluable! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice spelling improvement.
Please either rebase or create a new branch before each of your pull requests.
Your git log is a mess. It is making it hard to follow your changes.
@@ -29,7 +29,7 @@ An Algorithm is one or more functions that: | |||
- return one or more outputs, | |||
- have minimal side effects (Examples of side effects: `echo()`, `rand()`, `read()`, `write()`). | |||
|
|||
## Contributor agreement | |||
## Contributor Agreement |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should have a consistent rule for titles.
I propose lowercasing all but the first letter. That is the rule that I use in my research papers. Revert this change and lowercase all the other titles.
The Catalan numbers are a sequence of natural numbers that occur in the | ||
most large set of combinatorial problems. | ||
the largest set of combinatorial problems. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can never know in advance how many combinatorial sets of problems we will discover. Maybe we will find one more general than Catalan numbers in the future. Just let's rephrase this to say that it is very frequent.
## Time Complexity: O(K2n) | ||
## Space Complexity: O(Kn) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is K and what is n?
Why one is lowercase and not the other?
Drop the constant in the time complexity. If you insist on the constant, put it in front.
## | ||
## Time Complexity: O(K2n) | ||
## Space Complexity: O(Kn) | ||
## https://www.cs.cmu.edu/~epxing/Class/10708-20/scribe/lec4_scribe.pdf |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move the Wikipedia link under this link.
@@ -1,4 +1,14 @@ | |||
# Viterbi | |||
## The Viterbi algorithm is a dynamic programming algorithm | |||
## for obtaining the maximum a posteriori probability estimate | |||
## of the most likely sequence of hidden states |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## of the most likely sequence of hidden states | |
## of the most likely sequence of hidden states in a hidden Markov model. |
Fixing grammatical mistakes
By Grammarly
Adding description and reference to the Viterbi Algorithm
* Add a sample of maths basic algorithms * Update maths/abs.nim Co-authored-by: Zoom <[email protected]> * Use openArray in absMaxSort Co-authored-by: Zoom <[email protected]> * Fix seq->openArray and int->SomeInteger * Use Positive as input instead * Update maths/addition_without_arithmetic.nim Co-authored-by: Pietro Peterlongo <[email protected]> * Name allocation number * [maths/abs] Replace maxAbsSort by signed[Min/Max]Abs * [Aliquot Sum] Add header * Add empty line at end of file * Remove Allocation number since it is a non standard algorithm * Fix titles * Run nimpretty on the files * Rename file and add DIRECTORY.md * abs: Fix variable name * Add export marker Co-authored-by: Zoom <[email protected]> * Add RE block in aliquot sum and improve RE Co-authored-by: Zoom <[email protected]> * Remove MD quotation marks for inline code * Add export marker for RE block * Remove extra ValueError --------- Co-authored-by: Dimitri LESNOFF <[email protected]> Co-authored-by: Zoom <[email protected]> Co-authored-by: Pietro Peterlongo <[email protected]> Co-authored-by: David Leal <[email protected]>
* Use a dynamic allocated array (sequence) for strings * Run nimpretty * Add requested changes * Fix documentation generation * Fix test title according to changes Co-authored-by: Satin Wuker <[email protected]> * Update comments to warn about indexing issues Modified a bit the suggestions of comments. Please check them before approving. Co-authored-by: Zoom <[email protected]> --------- Co-authored-by: Dimitri LESNOFF <[email protected]> Co-authored-by: Satin Wuker <[email protected]> Co-authored-by: Zoom <[email protected]>
…hms#41) This will run `sudo apt-get update` before running any other commands on the Gitpod prebuild image (`.gitpod.dockerfile`).
…s#42) * Update README.md Use more extended markdown syntax instead of HTML, Add Matrix links Superseed PR TheAlgorithms#40 * Actually fix gitter! Move img src links to footer. Also changed the TheAlgorithms logo image link. * Restore TheAlgorithms logo link * More link fixes --------- Co-authored-by: dlesnoff <[email protected]>
Please, look at the edit below. I made a huge error on your branch. I tried to rebase and force push to remove these commits about linear search and bubble sort. By doing so, I put new commits that were not on your branch on top of yours, thus modifying the commit timestamps. EDIT: I think that merging with main solved the issue. |
No description provided.