Skip to content

Documentatino for tabular format#1097

Merged
jihyeonyi merged 5 commits intoopen-edge-platform:developfrom
jihyeonyi:tabular-doc
Jul 18, 2023
Merged

Documentatino for tabular format#1097
jihyeonyi merged 5 commits intoopen-edge-platform:developfrom
jihyeonyi:tabular-doc

Conversation

@jihyeonyi
Copy link
Copy Markdown

@jihyeonyi jihyeonyi commented Jul 14, 2023

Summary

Add documentation for tabular data format.

How to test

Checklist

  • I have added unit tests to cover my changes.​
  • I have added integration tests to cover my changes.​
  • I have added the description of my changes into CHANGELOG.​
  • I have updated the documentation accordingly

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below).
# Copyright (C) 2023 Intel Corporation
#
# SPDX-License-Identifier: MIT

@jihyeonyi jihyeonyi added this to the 1.5.0 milestone Jul 14, 2023
@jihyeonyi jihyeonyi added the doc Improvements or additions to documentation label Jul 14, 2023
@jihyeonyi jihyeonyi marked this pull request as ready for review July 14, 2023 04:56
@jihyeonyi jihyeonyi requested review from a team as code owners July 14, 2023 04:56
@jihyeonyi jihyeonyi requested review from wonjuleee and removed request for a team July 14, 2023 04:56
Co-authored-by: Vinnam Kim <vinnam.kim@gmail.com>
import datumaro as dm
dataset = dm.Dataset.import_from('<path/to/buddy/dataset>', 'tabular', target=["breed_category", "pet_category"])
dataset = dm.Dataset.import_from('<path/to/electricity/dataset>', 'tabular', target="class")
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about showing an example of how a table is displayed?
like df.head() in pandas or

|   date   | day | period   | nswprice | nswdemand | vicprice | vicdemand | transfer | class |
|----------|-----|----------|----------|-----------|----------|-----------|----------|-------|
| 0.425556 |  5  | 0.340426 | 0.076108 |  0.392889 | 0.003467 |  0.422915 | 0.414912 |   UP  |

If it is not proper this, please ignore this.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good idea, and I added examples at last.

Jihyeon Yi and others added 3 commits July 17, 2023 14:09
@jihyeonyi jihyeonyi requested a review from sooahleex July 17, 2023 08:01
Copy link
Copy Markdown
Contributor

@sooahleex sooahleex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@jihyeonyi jihyeonyi merged commit 279fae1 into open-edge-platform:develop Jul 18, 2023
@jihyeonyi jihyeonyi deleted the tabular-doc branch July 18, 2023 01:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants