Skip to content

Expand README with Data Instructions #4

@Jinxxxx1234

Description

@Jinxxxx1234

Summary

The README describes the project and usage but does not clearly specify how to obtain the dataset or where it should be placed locally.

Proposed Improvement

  • Add a "Data" section to the README.

  • Include:

    • Dataset source link
    • Instructions for downloading
    • Expected directory structure (e.g., data/raw/)
    • Any preprocessing steps required before running the notebook

Rationale

Clear data instructions improve usability and make the project easier to reproduce for collaborators and reviewers.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions