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

Update setup dependencies + fix YAML bug + fix diagram + fix typo in docstring + tutorial setup #103

Merged
merged 20 commits into from
Jan 4, 2024

Conversation

MilagrosMarin
Copy link
Collaborator

@MilagrosMarin MilagrosMarin commented Dec 11, 2023

This PR was intended to:

  • Fix typo in model_description docstring

This PR has also introduced the following changes:

  • Color update in the flowchart images and update the name as in element-calcium-imaging
  • Set up of dj.config() for the tutorial / DevContainers is now in tutorial_pipeline.py instead of __init__.py
  • The packaging requirements of elements in setup.py will now install directly from GitHub instead of PyPI (no longer updated)
    • Consequently, fix the path directories used in the tutorial
    • Update the outputs of the tutorial
  • Minor changes in the tutorial markdown, aligning it with element-array-ephys tutorial

This PR also addresses the bug introduced by the latest update to the YAML dependency with the following error emerged in element_deeplabcut/readers/dlc_reader.py:

AttributeError: safe_load() has been removed, use yaml = YAML(typ= safe , pure=True) yaml.load(...) instead of file /workspaces/element-deeplabcut/element_deeplabcut/readers/dlc_reader.py , line 148 self._yml = yaml.safe_load(f)

By changing it as follows:

yaml_loader = yaml.YAML(typ='safe', pure=True) self._yml = yaml_loader.load(f)

These adjustments, along with the tutorial, have been tested successfully in Codespaces.

@ttngu207
Copy link
Contributor

This introduces changes to the table definition on the database side, and the change won't propagate backward.
So unless there is a very compelling need to do this change, I'd rather not touch it.

@MilagrosMarin
Copy link
Collaborator Author

This introduces changes to the table definition on the database side, and the change won't propagate backward. So unless there is a very compelling need to do this change, I'd rather not touch it.

@ttngu207 I would recommend preserving the change at line 310, as it specifically corrects the description (docstring), aligning with the definition already provided at line 332 (model_description).

@MilagrosMarin MilagrosMarin changed the title Adjustment of field length fix typo in docstring for model_description Dec 12, 2023
@MilagrosMarin
Copy link
Collaborator Author

I have reverted one of the changes and updated the title of this minor PR.

@MilagrosMarin MilagrosMarin changed the title fix typo in docstring for model_description Update setup dependencies + fix diagram + fix typo in docstring Dec 21, 2023
@MilagrosMarin
Copy link
Collaborator Author

I have incorporated new modifications into this PR.

@MilagrosMarin MilagrosMarin changed the title Update setup dependencies + fix diagram + fix typo in docstring Update setup dependencies + fix diagram + fix typo in docstring + tutorial setup Dec 22, 2023
@MilagrosMarin MilagrosMarin changed the title Update setup dependencies + fix diagram + fix typo in docstring + tutorial setup Update setup dependencies + fix YAML bug + fix diagram + fix typo in docstring + tutorial setup Dec 22, 2023
Copy link
Collaborator

@kushalbakshi kushalbakshi left a comment

Choose a reason for hiding this comment

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

Hi @MilagrosMarin, thank you for making these changes. It looks like style tests and the test DevContainer builds are failing. Once these are addressed we should be able to finish the review and merge. Let me know if you need any help getting those resolved.

@MilagrosMarin
Copy link
Collaborator Author

Hi @MilagrosMarin, thank you for making these changes. It looks like style tests and the test DevContainer builds are failing. Once these are addressed we should be able to finish the review and merge. Let me know if you need any help getting those resolved.

@kushalbakshi I've successfully re-tested the Dev Container, and it built and launched without issues. Additionally, I have also re-tested the tutorial, and it is functioning correctly. However, the element-deeplabcut tests require updating. If the errors you've highlighted stem from these outdated files, I recommend addressing this in a subsequent PR.

@kushalbakshi
Copy link
Collaborator

Hi @MilagrosMarin, thank you for making these changes. It looks like style tests and the test DevContainer builds are failing. Once these are addressed we should be able to finish the review and merge. Let me know if you need any help getting those resolved.

@kushalbakshi I've successfully re-tested the Dev Container, and it built and launched without issues. Additionally, I have also re-tested the tutorial, and it is functioning correctly. However, the element-deeplabcut tests require updating. If the errors you've highlighted stem from these outdated files, I recommend addressing this in a subsequent PR.

We cannot merge until at least the style tests have passed, which just requires applying Black formatting to all the files in the repo. I'm not sure what is causing the error with the devcontainer-build but I recommend you find the cause in the error stack and state whether and why this is expected before merging.

Also, do you expect the devcontainer build to take 74 minutes? That's how long it is taking before the error occurs.

@MilagrosMarin
Copy link
Collaborator Author

Hi @MilagrosMarin, thank you for making these changes. It looks like style tests and the test DevContainer builds are failing. Once these are addressed we should be able to finish the review and merge. Let me know if you need any help getting those resolved.

@kushalbakshi I've successfully re-tested the Dev Container, and it built and launched without issues. Additionally, I have also re-tested the tutorial, and it is functioning correctly. However, the element-deeplabcut tests require updating. If the errors you've highlighted stem from these outdated files, I recommend addressing this in a subsequent PR.

We cannot merge until at least the style tests have passed, which just requires applying Black formatting to all the files in the repo. I'm not sure what is causing the error with the devcontainer-build but I recommend you find the cause in the error stack and state whether and why this is expected before merging.

Also, do you expect the devcontainer build to take 74 minutes? That's how long it is taking before the error occurs.

Hi @MilagrosMarin, thank you for making these changes. It looks like style tests and the test DevContainer builds are failing. Once these are addressed we should be able to finish the review and merge. Let me know if you need any help getting those resolved.

@kushalbakshi I've successfully re-tested the Dev Container, and it built and launched without issues. Additionally, I have also re-tested the tutorial, and it is functioning correctly. However, the element-deeplabcut tests require updating. If the errors you've highlighted stem from these outdated files, I recommend addressing this in a subsequent PR.

We cannot merge until at least the style tests have passed, which just requires applying Black formatting to all the files in the repo. I'm not sure what is causing the error with the devcontainer-build but I recommend you find the cause in the error stack and state whether and why this is expected before merging.

Also, do you expect the devcontainer build to take 74 minutes? That's how long it is taking before the error occurs.

My apologies for any confusion earlier. Initially, I misunderstood that the failing style tests and test builds were related to Pytests, not GitHub Action tests. I've taken steps to address the GitHub Action tests by applying Black formatting to specific files, and these changes have resolved the issues. This changes have also optimized the devcontainer-build duration from 74 minutes to 18 minutes. All the checks, including style tests, have now passed successfully.

Thank you for your patience and guidance. If there are any further recommendations or specific areas that need attention, please let me know, and I'll promptly address them.

kushalbakshi
kushalbakshi previously approved these changes Jan 4, 2024
@kushalbakshi kushalbakshi dismissed their stale review January 4, 2024 18:32

CHANGELOG and version need updating

Copy link
Collaborator

@kushalbakshi kushalbakshi left a comment

Choose a reason for hiding this comment

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

Looks good @MilagrosMarin. Just needs the CHANGELOG and version.py updated.

@MilagrosMarin
Copy link
Collaborator Author

Looks good @MilagrosMarin. Just needs the CHANGELOG and version.py updated.

CHANGELOG and version.py updated, and YAML object added in model.py as suggested in parallel PR#102.

Copy link
Collaborator

@kushalbakshi kushalbakshi left a comment

Choose a reason for hiding this comment

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

Looks good, @MilagrosMarin. Thank you for making these changes.

@kushalbakshi kushalbakshi merged commit 499d85e into datajoint:main Jan 4, 2024
7 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.

3 participants