Skip to content

Commit

Permalink
update to sub-dir readme's
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Ororbia committed Apr 9, 2024
1 parent f3a95f9 commit f52d07f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
12 changes: 9 additions & 3 deletions exhibitors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,17 @@ The contents of each exhibitor sub-directory may be organized and structured
however the exhibitor requires, though it is recommended that each sub-directory
within an exhibitor's folder pertains to a single paper/publication or
application. The only file we require in an exhibitor's folder is a single
markdown file -- `README.md` -- containing information about the exhibitor and a
header containing the name of the exhibitor, e.g., the researcher, organization,
company, or research group/lab, as follows:
markdown file -- `README.md` at the top-level -- containing information
about the exhibitor and a header containing the name of the exhibitor,
e.g., the researcher, organization, company, or research group/lab,
as follows:
```markdown
# <NAME_OF_EXHIBITOR>

...rest of text...
```

It is up to the exhibitor to provide the relevant context and explanation of
how a set of models relate to one another (if they do), a research group's body of
ongoing work, or the broader goals they are meant to satisfy, hypotheses they
are meant to test, and general research questions they seek to answer.
9 changes: 5 additions & 4 deletions exhibits/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@

In this directory, each directory should contain a single scientific or
engineered model/project using ngc-learn. The content and organization within
this directory is dependent on the project/model/agent and generally will
contain application/task-specific structuring code, e.g., agent classes with
specified functions pertinent to the problem/task examined in a paper's
experiment. <!--Datasets should not be stored in this repo but instead referenced
an exhibit's directory is dependent on the project/model/agent the exhibit is
about and generally will contain application/task-specific structuring code,
e.g., agent classes with specified functions pertinent to the problem/task
examined in a paper's experiment.
<!--Datasets should not be stored in this repo but instead referenced
to their source locations.-->

The only file we specifically require in an exhibition's folder is a single
Expand Down

0 comments on commit f52d07f

Please sign in to comment.