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.

Sign up for GitHub

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

Jump to bottom

docs: add size info #48

Merged
merged 2 commits into from
Dec 15, 2023
Merged

docs: add size info #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ecf169
docs: add size info
cabreraalex Dec 1, 2023
a9b0502
account
cabreraalex Dec 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Check out the [Using Zeno](/docs/using-zeno/) docs for more information on how t
## Creating a Project

To create your own projects and reports, first create an account on [Zeno Hub](https://hub.zenoml.com/signup).
After logging in to Zeno Hub, generate your API key by clicking on your profile at the bottom left to navigate to your [account page](https://hub.zenoml.com/account).
After logging in to Zeno Hub, generate your API key by clicking on your profile at the top right to navigate to your [account page](https://hub.zenoml.com/account).

Next, install the `zeno-client` Python package, which is used to upload new datasets and AI system outputs:

Expand Down
6 changes: 3 additions & 3 deletions docs/views/spec/other.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ A vertical stack of keyed elements. Can be used to combine different element typ

#### Properties

| Property | Type | Description |
| -------- | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| keys | Record<string:[ViewElement](/docs/views/spec/other)> | List of objects mapping from a String key to a ViewElement used to render the content of the data behind the key. |
| Property | Type | Description |
| -------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| keys | Record\<string:[ViewElement](/docs/views/spec/other)\> | List of objects mapping from a String key to a ViewElement used to render the content of the data behind the key. |

## Separated Values

Expand Down
2 changes: 2 additions & 0 deletions docs/views/spec/spec.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ The top level of the View Specification contains keys for the three main inputs,
"data": ...,
"label": ...,
"output": ...,
"size": ...,
"displayType": ...
}
`}
Expand All @@ -51,4 +52,5 @@ The top level of the View Specification contains keys for the three main inputs,
| data | [ViewElement](/docs/views/spec/other) | How to render data entries. |
| label | [ViewElement](/docs/views/spec/other) | How to render label entries. |
| output | [ViewElement](/docs/views/spec/other) | How to render output entries. |
| size | "medium" \| "large" | Width of the instance. |
| displayType | Optional[String] | How to display data, label, and output entries. The default view is a vertical list and each of `data`, `label` and `output` must be [ViewElement](/docs/views/spec/other)s. If set to `"table"`, `data`, `label`, and `output` must be [Separated Values](/docs/views/spec/other#separated-values). |
Loading