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

[ENH] Removed local_node_query profile #72

Merged
merged 7 commits into from
Aug 8, 2024
Merged

[ENH] Removed local_node_query profile #72

merged 7 commits into from
Aug 8, 2024

Conversation

rmanaem
Copy link
Contributor

@rmanaem rmanaem commented Aug 6, 2024

Changes proposed in this pull request:

  • Removed local_node_query profile
  • Updated README.md
  • Removed mentions of NB_IS_FEDERATION_API env var

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

@rmanaem rmanaem added the pr-minor-breaking Feature or enhancement that breaks compatibility, will increment minor version (0.+1.0) label Aug 6, 2024
@alyssadai alyssadai self-requested a review August 6, 2024 17:36
Copy link
Contributor

@alyssadai alyssadai left a comment

Choose a reason for hiding this comment

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

Thanks @rmanaem for the PR!

A few comments from me:

  • Could you update the comment for NB_API_QUERY_URL in template.env to specify that this should be the f-API URL, and ensure we use port 8080 in the example to avoid confusion?
  • Similarly, I think we should update the description for NB_FEDERATE_REMOTE_PUBLIC_NODES in neurobagel_environment_variables.tsv to mention that when this is false, only locally specified nodes (in local_nb_nodes.json) are queried (or sth to that effect)
  • The links in the ## How to use section of the README are out of date. Can you update this to point to the Getting started / Configuring a node sections of the docs?
    • I think it might also be nice to link to the "Configuring a node" page at the top of the environment variable TSV, so users can find more info about the env vars - will leave that up to you
  • If it makes sense to you, let's wait until https://github.com/neurobagel/recipes/issues/71 is merged before merging this PR so that this change to the profiles can be versioned

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@rmanaem
Copy link
Contributor Author

rmanaem commented Aug 7, 2024

I think it might also be nice to link to the "Configuring a node" page at the top of the environment variable TSV, so users can find more info about the env vars - will leave that up to you

Not sure what you had in mind here, do you mean to add another row in the tsv?

@alyssadai
Copy link
Contributor

Not sure what you had in mind here, do you mean to add another row in the tsv?

Whoops, sorry that was a typo from my end. I meant in the template.env file, not the environment variable TSV!

@rmanaem rmanaem requested a review from alyssadai August 7, 2024 15:54
@rmanaem rmanaem added release Create a release when this PR is merged and removed release Create a release when this PR is merged labels Aug 7, 2024
Copy link
Contributor

@alyssadai alyssadai left a comment

Choose a reason for hiding this comment

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

one 🍒, otherwise 🧑‍🍳 !

README.md Outdated Show resolved Hide resolved
Co-authored-by: Alyssa Dai <[email protected]>
@alyssadai
Copy link
Contributor

Blocked until #75 is addressed

@alyssadai
Copy link
Contributor

This is ready to be merged!

@rmanaem rmanaem merged commit 4923feb into main Aug 8, 2024
@rmanaem rmanaem deleted the feat-70 branch August 8, 2024 15:05
Copy link
Contributor

🚀 PR was released in v0.1.0 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-minor-breaking Feature or enhancement that breaks compatibility, will increment minor version (0.+1.0) released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove local_node_query profile from docker-compose.yml
2 participants