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

Proofread of the agile modelling notebook #2

Open
2 of 11 tasks
vdumoulin opened this issue Dec 1, 2024 · 1 comment
Open
2 of 11 tasks

Proofread of the agile modelling notebook #2

vdumoulin opened this issue Dec 1, 2024 · 1 comment

Comments

@vdumoulin
Copy link

vdumoulin commented Dec 1, 2024

Hi Philip,

As I'm going through the notebook I'll add notes here on the issues and typos that I encounter. I'll post a reply in the issue once I'm done proofreading the notebook.

Issues:

  • [Typo] in the cloud on an Google Colab
  • [Issue] mkdir fails when the esa2024_data does not exist in /content/drive/My Drive. Solution: pass parents=True to Path.mkdir here.
  • [Readability] Let's remove this commented out line if it's not used.
  • [Clarity] It would be good to provide more details on how to obtain the auth token here.
  • [Issue] userdata is not imported, and this cell fails to execute.
  • [Issue] When downloading embeddings, the download_embeddings function fails and retries to download a few times (with a message like Error: ('Connection broken: IncompleteRead(1091684280 bytes read, 2499285495 more expected)', IncompleteRead(1091684280 bytes read, 2499285495 more expected))), and then I get OSError: [Errno 22] Invalid argument when trying to extract the zip file. I tried downloading the file manually and placing it in my drive to get past that error, and it appeared to have worked, but it looks like the download is flaky. Maybe this is due to me trying to download the zip file from halfway around the globe, but we should make sure that the download is reliable for workshop participants.
  • [Clarity] The default values for config.search_dataset_name and config.annotator_id cause agile.create_database to fail, but there is no clear call to action for the participant to change the value.
  • [Issue] In the default yellow-bellied glider project, ID 2507915 in site 4491 doesn't appear to be in the zip file. This doesn't appear to impact the rest of the notebook, though.
  • [Clarity] There doesn't appear to be a way to get our hands on a labeled example for the default yellow-bellied glider project, and the notebook currently does not elaborate on where the user is expected to put the recording and with what naming convention (if any).
  • [Issue] The call to agile.embed_query fails because the method no longer accepts input arguments. Solution: remove the query_uri argument.
  • [Clarity] It would be helpful to explain how users are expected to use the label buttons displayed after calling search_with_query.
@vdumoulin
Copy link
Author

I'm done proofreading the notebook.

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

No branches or pull requests

1 participant