Skip to content

Commit

Permalink
Fixes #4: Added Testing file + rewrap
Browse files Browse the repository at this point in the history
  • Loading branch information
Francois-Werbrouck committed Feb 28, 2024
1 parent 87a213c commit 03ee15b
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/workflows.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
name: ai-cfia workflows

on:

Check warning on line 4 in .github/workflows/workflows.yml

View workflow job for this annotation

GitHub Actions / workflow-yaml-check / yaml-lint-check

4:1 [truthy] truthy value should be one of [false, true]
Expand Down Expand Up @@ -25,4 +26,4 @@ jobs:
yaml-check:
name: workflow-yaml-check
uses: ai-cfia/github-workflows/.github/workflows/workflow-yaml-check.yml@main

Check failure on line 28 in .github/workflows/workflows.yml

View workflow job for this annotation

GitHub Actions / workflow-yaml-check / yaml-lint-check

28:81 [line-length] line too long (81 > 80 characters)
secrets: inherit
secrets: inherit
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

## Overview

We want to define a human editable metadata format associated to captured images of seeds for model training and analysis.
We want to define a human editable metadata format associated to captured images
of seeds for model training and analysis.

Capturing attributes associated to the images is essential for proper model training.
Capturing attributes associated to the images is essential for proper model
training.

## image format

Expand All @@ -17,11 +19,16 @@ We define metadata related to the file.

These are machine readable file formats that are popular:

* [csv](https://en.wikipedia.org/wiki/Comma-separated_values): often as an export of spreadsheet, each row is a single piece of data with columnar
* [json](https://www.json.org/): json is a standard for modern API dataformat, it defines a dictionary of keys and values with datatypes matching Javascript datatypes but now supported in most languages
* [yaml](https://yaml.org/): YAML is a human-friendly data serialization language for all programming languages
* [csv](https://en.wikipedia.org/wiki/Comma-separated_values): often as an
export of spreadsheet, each row is a single piece of data with columnar
* [json](https://www.json.org/): json is a standard for modern API dataformat,
it defines a dictionary of keys and values with datatypes matching Javascript
datatypes but now supported in most languages
* [yaml](https://yaml.org/): YAML is a human-friendly data serialization
language for all programming languages

Although originally proposing JSON, we will use YAML instead as it is easier to edit for users.
Although originally proposing JSON, we will use YAML instead as it is easier to
edit for users.

## on-disk directory/file structure

Expand All @@ -40,7 +47,8 @@ Although originally proposing JSON, we will use YAML instead as it is easier to

## import utility

Python script that reads from on-disk directory structure and converts it to database
Python script that reads from on-disk directory structure and converts it to
database

* yaml metadata is inherited recursively and properties are inherited
* some of the properties can be directly read from the source image
Expand All @@ -51,7 +59,8 @@ Python script that reads from on-disk directory structure and converts it to dat

(TODO: ERD (Entity-Relationship Diagram) here)

attributes are both from the yaml metadata and the images themselves metadata and file (timestamps)
attributes are both from the yaml metadata and the images themselves metadata
and file (timestamps)

entities

Expand Down
Empty file added TESTING.md
Empty file.

0 comments on commit 03ee15b

Please sign in to comment.