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

Utils renaming #138

Merged
merged 13 commits into from
May 9, 2024
Merged

Utils renaming #138

merged 13 commits into from
May 9, 2024

Conversation

ztq1996
Copy link
Contributor

@ztq1996 ztq1996 commented May 7, 2024

Problem & Solution Description (including issue #)

Code Quality

  • My code follows the code style of this project
  • I have written unit tests or justified all instances of #pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added
  • My code contains relevant comments and necessary documentation for future maintainers; the change is reflected in applicable demos/tutorials (with output cleared!) and added/updated docstrings use the NumPy docstring format
  • Any breaking changes, described above, are accompanied by backwards compatibility and deprecation warnings

@@ -95,7 +95,7 @@
"source": [
"# with prefix\n",
"\n",
"print(rail.core.util_stages.ColumnMapper)"
"print(from rail.utils.stage_utils.ColumnMapper)"
Copy link
Contributor

Choose a reason for hiding this comment

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

Doesn't look correct.

@OliviaLynn OliviaLynn self-requested a review May 8, 2024 21:31
Copy link
Member

@OliviaLynn OliviaLynn left a comment

Choose a reason for hiding this comment

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

Left a comment about the goldenspike.yml file; this looks good!

@@ -1,6 +1,6 @@
This directory contains an example notebook showing a simplified version of the end-to-end functionality of RAIL.

- [goldenspike.ipynb](https://lsstdescrail.readthedocs.io/en/latest/source/other-notebooks.html#goldenspike-an-example-of-an-end-to-end-analysis-using-rail) is a notebook that chains together the functionality of the creation, estimation, and evaluation modules.
- [goldenspike.ipynb](https://rail-hub.readthedocs.io/projects/rail-notebooks/en/latest/rendered/goldenspike_examples/goldenspike.html) is a notebook that chains together the functionality of the creation, estimation, and evaluation modules.
Copy link
Member

Choose a reason for hiding this comment

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

Nice catch!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

all credit to @JaimeRZP
#134

name: line_confusion
nprocess: 1
- classname: QuantityCut
module_name: rail.creation.degradation.quantityCut
module_name: rail.creation.degraders.quantityCut
name: quantity_cut
nprocess: 1
- classname: ColumnMapper
Copy link
Member

Choose a reason for hiding this comment

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

Looking at the reference to some rail.core.utilStages here, I wonder if we shouldn't just remove this file completely. When I try to search "utilStages" in my all-rail directory, nothing shows up.

I'm worried this file is probably a little old and unmaintained, and might be more harmful than helpful if we keep it around in a broken state. Additionally, I've found that recent opinions seem to be that any yaml pipeline files will live either in rail_pipelines or some other repo designed explicitly for storing and sharing pipelines.

Copy link
Member

Choose a reason for hiding this comment

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

(And when I say here, I mean a couple lines below, in the Columm Mapper stage and a few others. Github inconveniently limits comments to code the PR touches, which, I guess, fair.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, yeah I get that, it is my negligence for missing the core.utilStages here, they should be tools.table_tools. I will fix it for now but let's discuss during the tag-up about whether we still want yml in the examples here .

@ztq1996 ztq1996 merged commit 66cace4 into main May 9, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants