Skip to content

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

@Tobias-Fischer

Description

@Tobias-Fischer

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 :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions