Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clean up description of groups of columns in model output #201

Closed
elray1 opened this issue Oct 22, 2024 · 1 comment · Fixed by #202
Closed

clean up description of groups of columns in model output #201

elray1 opened this issue Oct 22, 2024 · 1 comment · Fixed by #202
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@elray1
Copy link
Contributor

elray1 commented Oct 22, 2024

Looking at this page: https://hubverse.io/en/latest/user-guide/model-output.html#model-output-format

Screenshot of specific text block:
image

Comments:

  • I believe the intent here was probably to nest points 3 through 5 as a sublist under point 2, but they ended up as items at the same outer list level.
  • However, I'd suggest updating this as follows:
  1. "Model output representation" (2 columns): consists of two columns specifying how the model outputs are represented. Both of these columns will be present in all model output data:
    1. output_type ...
    2. output_type_id ...
  2. value contains the model's prediction.

The rationale here is that output_type and output_type_id specify how model outputs are represented, but value is the actual model output rather than metadata about the representation of that output.

(We've iterated on this text in a past PR, but I couldn't quickly find a link with meaningful discussion.)

@micokoch micokoch self-assigned this Oct 23, 2024
@micokoch micokoch added the documentation Improvements or additions to documentation label Oct 23, 2024
@micokoch micokoch moved this from Todo to In Progress in hubverse Development overview Oct 23, 2024
micokoch added a commit to micokoch/hubDocs that referenced this issue Oct 23, 2024
@micokoch
Copy link
Contributor

Hi Evan. I remember we talked about this, and I used the structure in the hubEnsembles manuscript. Anyway, I updated the structure as you suggested in PR #202.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants