Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jcpsantiago authored Jul 4, 2021
1 parent c002547 commit 17acae7
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ It will have the following folder structure and initiate DVC for you

```sh
.
├── data # all data that's not a model, metrics or plots goes here
│ ├── intermediate # outputs of each stage to be used in future stages
│ └── raw # original data; should never be overwritten; saved in remote storage with DVC
├── metrics # metrics of interest in JSON; DVC can track these over time
├── models # final output of your pipeline, in case it's a model
├── plots # any plots produced, including CSVs with data for plots (see DVC docs)
├── queries # .sql files or other format so that queries are also tracked
├── R # additional R functions needed for this project and not in a pkg yet
├── reports # more complete reports or model cards
└── stages # scripts for each stage; doesn't need to be only in R!
├── data # all data that's not a model, metrics or plots goes here
│ ├── intermediate # outputs of each stage to be used in future stages
│ └── raw # original data; should never be overwritten; saved in remote storage with DVC
├── metrics # metrics of interest in JSON; DVC can track these over time
├── models # final output of your pipeline, in case it's a model
├── plots # any plots produced, including CSVs with data for plots (see DVC docs)
├── queries # .sql files or other format so that queries are also tracked
├── R # additional R functions needed for this project and not in a pkg yet
├── reports # more complete reports or model cards
└── stages # scripts for each stage; doesn't need to be only in R!
```

This structure assumes a DVC pipeline for Machine Learning made out of multiple `stages/*.R` which will
Expand Down

0 comments on commit 17acae7

Please sign in to comment.