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

Some ways to contribute to PyFixest #281

Closed
s3alfisc opened this issue Feb 3, 2024 · 1 comment
Closed

Some ways to contribute to PyFixest #281

s3alfisc opened this issue Feb 3, 2024 · 1 comment
Labels
help wanted Extra attention is needed

Comments

@s3alfisc
Copy link
Member

s3alfisc commented Feb 3, 2024

There are many ways to contribute to PyFixest - here I list a few things that are on my to do list and seem like good first issues to me =) In general if you have any questions, please reach out to me by asking here or by sending me an email!

If you want to familiarize yourself with the codebase, the best starting point is pyfixest.estimation.feols. You can then follow its flow through the entire codebase. First you'll reach the FixestMulti class, which first deparses the formula string in FixestFormulaParser (you might want to skip this in the beginning, as it is not very pretty code 😅 ). From there, you more or less get a dictionary with formula strings, which FixestMulti._estimate_all_models loops over. In general, this is the key method where most of the action happens: the creation of the model matrix via model_matrix_fixest, the demeaning (and caching) of variables by the fixed effects via demean_all_models, and finally estimation via the Feols, Feiv or Fepois classes.

I'd also appreciate more general feedback on software engineering aspects of the code base =)

@s3alfisc s3alfisc added the help wanted Extra attention is needed label Feb 3, 2024
@s3alfisc s3alfisc pinned this issue Feb 3, 2024
@s3alfisc s3alfisc changed the title How to contribute to PyFixest Some ways to contribute to PyFixest Feb 3, 2024
@s3alfisc
Copy link
Member Author

Everything suggest in here is implemented, so we can close this =)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant