SAP / SAP/knn-sampler

Documentation in markdown for user custom dataset usage

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
10
Forks
2
Avg merge
1d 5h
Merged PRs (30d)
15

Description

if anyone wants to train on his data :

  1. he puts the excel file into his project
  2. he goes to dataset_description.py
  3. he fills the datasetDescription with useful infos, for exemple
class Dataset:
    PUBLICATION_DATASET = ExcelDatasetDescriptor(
        "IRRADIATION",
        "DC_POWER",
        "pub/publishable_data.xlsx",
        "Sheet1"
    )
  1. If he want to use the dataset he just described, he can now specify it in the config.py file (in the latest commit)

This guide needs to be reviewed, formatted and put in the README.md, maybe add some instructions for other file types

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the dataset_description.py example and the config.py usage described in the issue, then review the existing README.md. Document the custom Excel dataset workflow clearly, format the example, and determine whether guidance for other file types can be added. Done means the README contains an accurate, understandable guide for using a custom dataset.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.