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

A few suggestions to improve the quality of the repo #10

Open
Tobias-Fischer opened this issue Sep 27, 2024 · 0 comments
Open

A few suggestions to improve the quality of the repo #10

Tobias-Fischer opened this issue Sep 27, 2024 · 0 comments

Comments

@Tobias-Fischer
Copy link

Hi @jasonlyik,

I finally got around looking at this :).

A few suggestions:

  • Improve the README with a "Get started" or similar that contains installation instructions + most common commands to run; also in the README refer to the other Markdown documents
  • Add a requirements.txt / pyproject.toml / pixi.toml file to easily install dependencies
  • Add a LICENSE, and add license information in all code files
  • Move the ASC.md / QUBO.md in the relevant subdirectories as "README.md" files
  • In download_dcase_dataset.py:
    • Do we really need the MKDIR_MODE? Could cause trouble on Windows I imagine ..
    • Why not just call download_dcase_audio_data() in the __main__()? Feels like duplicated handling of the default path.
  • In dcase_audio_scene_classification.py: Why return self in def to()?

Otherwise looks good & exciting :)

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