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

Rename to pymc-extras #404

Merged
merged 2 commits into from
Dec 13, 2024
Merged

Rename to pymc-extras #404

merged 2 commits into from
Dec 13, 2024

Conversation

fonnesbeck
Copy link
Member

@fonnesbeck fonnesbeck commented Dec 11, 2024

Changes instances of *-experimental to *-extras throughout. Also renames the module itself, and deals with renaming on all imports. Additional cleanup as dictated by linting.

@ricardoV94
Copy link
Member

Want to also update imports/docstrings in the codebase?

@wd60622
Copy link
Contributor

wd60622 commented Dec 11, 2024

And the environment names in conda-envs/

I'm happy to help out with the migration

@fonnesbeck fonnesbeck changed the title Renamed experimental to extras in README Complete renaming of repository Dec 11, 2024
@ricardoV94
Copy link
Member

@OriolAbril anything special needed for RTD?

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@fonnesbeck
Copy link
Member Author

OK, that took some doing. Should be clean now.

@wd60622
Copy link
Contributor

wd60622 commented Dec 11, 2024

What will the new import look like? 🤔

@fonnesbeck
Copy link
Member Author

import pymc_extras as pmx

@fonnesbeck
Copy link
Member Author

This appears to have broken the statespace module quite badly.

@ricardoV94
Copy link
Member

ricardoV94 commented Dec 11, 2024 via email

@wd60622
Copy link
Contributor

wd60622 commented Dec 12, 2024

This have functional changes as well?

.github/workflows/pypi.yml Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

Should the version number be changed since it's a new package?

Copy link
Member

Choose a reason for hiding this comment

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

That's fine, we can continue from the old numbering. We did that with pymc and I think it's a bit easier to follow along

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, it will make it obvious when the renaming occurred.

@fonnesbeck
Copy link
Member Author

And just like that, tests pass.

@fonnesbeck
Copy link
Member Author

Can this be merged?

Comment on lines -11 to -14
SteadyStateFilter
KalmanSmoother
SingleTimeseriesFilter
CholeskyFilter
Copy link
Member

Choose a reason for hiding this comment

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

Unrelated changes? Did you merge main instead of rebasing? Makes it a bit hard to check

Copy link
Member Author

Choose a reason for hiding this comment

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

I removed these because they did not seem to exist in the code base, so tests were failing.

Copy link
Member

Choose a reason for hiding this comment

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

I think it was a chicken and egg situation. Something got removed in one file and then kept breaking other stuff. AFAICT they still existed in main

Copy link
Member

Choose a reason for hiding this comment

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

The cholesky, was renamed to SquareRootFilter. The others were removed as you said

@ricardoV94
Copy link
Member

@fonnesbeck I'm going to squash the commits and rebase to see if the github changed lines become more streamlined

@OriolAbril
Copy link
Member

I have never renamed a readthedocs project, not even sure if it is possible. As of now, the docs are their own rtd project: pymc-experimental Its direct url is https://pymc-experimental.readthedocs.io but it gets published as a subproject of the main pymc website which makes the actual url https://www.pymc.io/projects/experimental/en/latest/ (the other one works but redirects here).

Is it ok to keep these urls or do we want those updated? If updated, even if the experimental ones break. I am not sure it will be possible to redirect, maybe if we rename and create an empty pymc-experimental rtd project (again) that only has a link/redirects to the extras one.

Everything is configured from the rtd website though so nothing that needs to happen in this PR. Once you tell me which of the different options is the preferred one I'll try to make it happen

@ricardoV94
Copy link
Member

@fonnesbeck I reverted all accidental functional changes I could find.

@ricardoV94
Copy link
Member

Is it ok to keep these urls or do we want those updated?

Whatever is less work for us

Copy link
Member

@ricardoV94 ricardoV94 left a comment

Choose a reason for hiding this comment

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

Let's see if the tests pass

@ricardoV94 ricardoV94 changed the title Complete renaming of repository Rename to pymc-extras Dec 13, 2024
@fonnesbeck
Copy link
Member Author

They do!

@ricardoV94 ricardoV94 merged commit 88ebb31 into pymc-devs:main Dec 13, 2024
6 checks passed
@ricardoV94
Copy link
Member

All existing PRs will have to be rebased and we should create a pypi pckage ASAP @fonnesbeck

@fonnesbeck
Copy link
Member Author

fonnesbeck commented Dec 13, 2024

It doesn't look like we can rename pymc-experimental, so I will have to create a new project. The next version is slated to be 0.1.5 but shall we jump to 0.2.0 for this? Or dare we make this a major version?

@ricardoV94
Copy link
Member

It doesn't look like we can rename pymc-experimental, so I will have to create a new project. The next version is slated to be 0.1.5 but shall we jump to 0.2.0 for this? Or dare we make this a major version?

I would do 0.2. Maybe we'll have something very flashy for 1.0

@fonnesbeck
Copy link
Member Author

I would do 0.2. Maybe we'll have something very flashy for 1.0

Coward.

@fonnesbeck
Copy link
Member Author

fonnesbeck commented Dec 13, 2024

OK uploaded a test here: https://test.pypi.org/project/pymc-extras/0.2.0/

If everything looks good I can do it for realz.

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

Successfully merging this pull request may close these issues.

4 participants