Skip to content

Commit 35851cc

Browse files
authored
fix life cycle page formatting (#61)
1 parent 09a7668 commit 35851cc

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/wiki-guide/Digital-Product-Lifecycle.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,44 +11,44 @@ Although most of the engagement from the side of research teams is expected to (
1111

1212
The following adds additional context and direction to supplement the diagram, organized by project lifecycle stage.
1313

14-
### Setup Phase:
14+
### Setup Phase
1515

1616
* NextGens and/or project[^1] PIs schedule a project consultation with the Senior Data Scientist. This will include scope and intended data usage for improved research convergence and to ensure projects start with all available resources in mind.
1717
* In GitHub project repo, create an issue for each of the repositories for the digital products with the appropriate checklist:
18-
* **Code and workflows:** GitHub Repository ([Code checklist](Code-Checklist.md)).
19-
* **Datasets:** Hugging Face Dataset Repository ([Data checklist](Data-Checklist.md)).
20-
* For already published data usage, see the [Metadata Checklist](Metadata-Checklist.md).
21-
* **ML Models:** Hugging Face Model Repository ([Model checklist](Model-Checklist.md)).
18+
* **Code and workflows:** GitHub Repository ([Code checklist](Code-Checklist.md)).
19+
* **Datasets:** Hugging Face Dataset Repository ([Data checklist](Data-Checklist.md)).
20+
* For already published data usage, see the [Metadata Checklist](Metadata-Checklist.md).
21+
* **ML Models:** Hugging Face Model Repository ([Model checklist](Model-Checklist.md)).
2222

23-
### Exploration Phase:
23+
### Exploration Phase
2424

2525
* Maintain record of any and all data utilized (source, license, citation, etc.).
26-
* See [Data Sources Template](https://docs.google.com/spreadsheets/d/1r4-_Ytg2bwGMxLpYrk4GVhx61JSOYXANsSFjryNmsDE/edit?usp=drive_link).
26+
* See [Data Sources Template](https://docs.google.com/spreadsheets/d/1r4-_Ytg2bwGMxLpYrk4GVhx61JSOYXANsSFjryNmsDE/edit?usp=drive_link).
2727
* Document exploration of data.
28-
* This establishes an understanding of what the data is and how it can be used. For an example and guidance, consider the exploration and documentation done in the [Data Workshop](https://github.com/Imageomics/data-workshop-AH-2024).
28+
* This establishes an understanding of what the data is and how it can be used. For an example and guidance, consider the exploration and documentation done in the [Data Workshop](https://github.com/Imageomics/data-workshop-AH-2024).
2929
* Record processing steps applied—maintained in a well-documented code repository (following [GitHub Guidance](GitHub-Repo-Guide.md))—and update Dataset Card(s) with information and links back to GitHub repository.
3030
* Establish and update contributor list—follow the [Imageomics Author Guide](https://docs.google.com/spreadsheets/d/1GwlCukfoQPL8JI2yyWRD3g4uiMTO3tlGNE_qeb_xBCs/edit?usp=sharing).[^2]
31-
* Authors and author order for the paper and codebase (and/or dataset) may differ, all should be discussed.
31+
* Authors and author order for the paper and codebase (and/or dataset) may differ, all should be discussed.
3232

33-
### Model Development Phase:
33+
### Model Development Phase
3434

3535
* Maintain a record of any and all base models utilized (source, license, citation, etc.).
3636
* Record model experiments—scripts or Jupyter Notebooks, _documented_[^3] and maintained in GitHub for version control as different approaches are tried.
3737
* Document model experiments and evaluation—record results of various tests performed and overall evaluation and comparison of these runs in Model Card(s) with links back to GitHub repository.
3838
* Add all code used to generate figures to the project GitHub repository; including documentation for reproduction (e.g., package requirements, data info, instructions).
3939
* Review (and revise as necessary) the Author/Contributor list(s).
4040

41-
### Preparing for Publication:
41+
### Preparing for Publication Phase
4242

4343
* Project components should align with FAIR and Reproducibility principles:
44-
* Completed and fully documented GitHub Repository for code (recall [Code checklist](Code-Checklist.md)).
45-
* Completed and fully documented Hugging Face Dataset Repository for data products (recall [Data checklist](Data-Checklist.md)).
46-
* If using an already published dataset, all requisite metadata and provenance information included (recall [Metadata checklist](Metadata-Checklist.md)). Specifically, ensure that all attribution requirements and/or expectations have been appropriately met.
47-
* Completed and fully documented Hugging Face Model Repository for ML models (recall [Model checklist](Model-Checklist.md)).
44+
* Completed and fully documented GitHub Repository for code (recall [Code checklist](Code-Checklist.md)).
45+
* Completed and fully documented Hugging Face Dataset Repository for data products (recall [Data checklist](Data-Checklist.md)).
46+
* If using an already published dataset, all requisite metadata and provenance information included (recall [Metadata checklist](Metadata-Checklist.md)). Specifically, ensure that all attribution requirements and/or expectations have been appropriately met.
47+
* Completed and fully documented Hugging Face Model Repository for ML models (recall [Model checklist](Model-Checklist.md)).
4848
* Schedule Review by Senior Data Scientist of data, model, and code repositories 3 weeks prior to camera-ready deadline (approval required for DOI generation).
4949
* Review (and revise as necessary) the Author/Contributor list(s).
5050

51-
[^1]: Here we use the term project at a smaller scale to mean any endeavor resulting in a digital product (dataset, ML model, code) and/or paper (e.g., for the purposes of this policy [SST](https://github.com/Imageomics/SST) is a *project*, while Butterflies is not).
51+
[^1]: Here we use the term project at a smaller scale to mean any endeavor resulting in a digital product (dataset, ML model, code) and/or paper (e.g., for the purposes of this policy [SST](https://github.com/Imageomics/SST) is a _project_, while Butterflies is not).
5252

5353
[^2]: Contributor lists should be started as early as possible and are subject to change as a project progresses; this is expected and the reason to review during each phase of development.
5454

0 commit comments

Comments
 (0)