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

Docstring clarification #4

Open
TheChymera opened this issue Sep 3, 2017 · 2 comments
Open

Docstring clarification #4

TheChymera opened this issue Sep 3, 2017 · 2 comments
Assignees
Labels
Milestone

Comments

@TheChymera
Copy link
Member

TheChymera commented Sep 3, 2017

  1. Could you please clarify the following section of the docstring?

    a list of cosgen.sequence.Sequence objects. If the
    function as an argument 'cross_over_fct' a cross over
    function has to be set in advance using the set_cross_over
    method. The 'cross_over_fct' parameter is then fixed to
    this function.
    I assume it's just a typo as/has --- but I still don't understand where a crossover function would be specified, and what it means to have it fixed to this function.

  2. COSgen/cosgen/models.py

    Lines 133 to 135 in d68af52

    sequence. Colums of the desing matrix are a constant
    (ones) a linear time course and the convolution of the
    basis vetors with the sequence.
    This needs commas for the ennumeration, and *vectors has a typo, but most importantly: would linearly decaying time course not be a better description? Same here:

    COSgen/cosgen/models.py

    Lines 230 to 232 in d68af52

    sequence. Colums of the desing matrix are a constant
    (ones) a linear time course and the convolution of `hrf`
    with the sequence.

  3. Unsure what cave means here:

    *CAVE*: A must contain already orthogonalized column vectors!!

@TheChymera TheChymera added the bug label Sep 3, 2017
@TheChymera TheChymera changed the title Docstring clarification for set generate immigrants Docstring clarification Sep 3, 2017
@TheChymera TheChymera added this to the MSc Release milestone Sep 3, 2017
@TheChymera TheChymera assigned TheChymera and faymanns and unassigned TheChymera Sep 3, 2017
@faymanns
Copy link
Member

faymanns commented Sep 3, 2017

I think I fixed them all.
Not sure if the first one is clear now:

This method sets a generate immigrants function used by
the genetic algorithm. The function should normally return
a list of `cosgen.sequence.Sequence` objects. `function`
may use a cross over function for the construction
of immigrants. If `function` has a parameter
'cross_over_fct' it is automatically set to the function
previously set with `set_cross_over`.

@TheChymera
Copy link
Member Author

Yes, it's still not very clear what is set to which function, and what being set means. Do you mean the argument is passed to another function? as a **keyword argument?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants