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

[MAIN] Fix typos and grammatical errors in GPFA tutorial #587

Conversation

kushaangupta
Copy link
Contributor

No description provided.

@coveralls
Copy link
Collaborator

coveralls commented Jul 30, 2023

Coverage Status

coverage: 86.64% (-0.3%) from 86.977% when pulling cf9ad1e on kushaangupta:maintenance/gpfa-tut-typos into 2bd871a on NeuralEnsemble:master.

Copy link
Member

@Moritz-Alexander-Kern Moritz-Alexander-Kern left a comment

Choose a reason for hiding this comment

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

Hey @kushaangupta ,
thanks for helping to improve the GPFA tutorial.

It seems in the first code cell the following lines were removed unintentionally ?!
See: https://elephant--587.org.readthedocs.build/en/587/tutorials/gpfa.html

def integrated_lorenz(dt, num_steps, x0=0, y0=1, z0=1.05,
                      sigma=10, rho=28, beta=2.667, tau=1e3):
    """

    Parameters
    ----------
    dt :
        Integration time step in ms.

The other changes look good to me 💯 .

@kushaangupta
Copy link
Contributor Author

Hi @Moritz-Alexander-Kern , sorry about that error. I've fixed it now. Also, I also see that the plots in the second half of tutorial, GPFA on Lorentz system haven't been rendered in the uploaded notebook. Should I fix that or are they intentionally not plotted?

@Moritz-Alexander-Kern
Copy link
Member

Hi @kushaangupta ,
I appreciate you bringing this to my attention. I must admit that I overlooked the fact that the second half of the notebook was not executed.
Would you kindly execute the entire notebook and push the executed version?
Feel free to also delete the last two cells of the notebook.
One of the cells is empty, and the other one only contains the code print(scipy.__version__). These cells are no longer needed, so removing them will help keep the notebook clean and concise.
Thank you for your help. 🙂

@kushaangupta
Copy link
Contributor Author

I pushed the fix

Copy link
Member

@Moritz-Alexander-Kern Moritz-Alexander-Kern left a comment

Choose a reason for hiding this comment

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

Approved, thanks @kushaangupta .

@Moritz-Alexander-Kern
Copy link
Member

Failing unit tests fixed: #588

@Moritz-Alexander-Kern Moritz-Alexander-Kern added this to the v0.14.0 milestone Sep 18, 2023
@Moritz-Alexander-Kern Moritz-Alexander-Kern merged commit 16c5953 into NeuralEnsemble:master Oct 10, 2023
11 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants