kubeedge/ianvs

Add more information about dataset

Open

#110 opened on Jun 27, 2024

View on GitHub
 (8 comments) (2 reactions) (1 assignee)Python (168 forks)auto 404
good first issuekind/cleanup

Repository metrics

Stars
 (178 stars)
PR merge metrics
 (PR metrics pending)

Description

In testenv.yaml configuration, train_url and test_url is configured.

But no document is about how these two data files should be prepared.

For example, what data format is needed? I think if there is a example, it will be better for people new to this project to use.

The document should cover TXT, CSV, JSON, which is in load data class

Contributor guide

Research direction
Look at the dataset loading class in core/testenvmanager/dataset/dataset.py to understand how TXT, CSV, and JSON files are expected to be formatted. Then search the repository for existing documentation or examples about testenv.yaml and train url/test url. Based on that, determine where to add documentation and what example data to include.
Tech stack
python
Domain
databackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85