Skip to content
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.

docs: Update the CLI and Endpoint pages to reflect the new changes #38

Merged
merged 11 commits into from
Jun 19, 2024

Conversation

irfanpena
Copy link
Contributor

@irfanpena irfanpena commented Jun 18, 2024

Describe Your Changes

  • Update the CLI pages to reflect the new changes
  • Add the telemetry command
  • Update the json file to reflect the new updates

Fixes Issues

  • Closes #
  • Closes #

Self Checklist

  • Added relevant comments, esp in complex areas
  • Updated docs (for bug fixes / features)
  • Created issues for follow-up changes or refactoring needed

@irfanpena irfanpena self-assigned this Jun 18, 2024
@irfanpena irfanpena marked this pull request as draft June 18, 2024 01:27
@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Jun 18, 2024
Copy link

github-actions bot commented Jun 18, 2024

Preview URL: https://4f90b8d9.cortex-docs.pages.dev

@irfanpena irfanpena changed the title docs: Update the CLI pages to reflect the new changes docs: Update the CLI and Endpoint pages to reflect the new changes Jun 18, 2024
@irfanpena irfanpena requested a review from freelerobot June 18, 2024 07:25
:::


## Options

| Option | Description | Required | Default value |
|----------------------------------|-----------------------------------------------------------------------------|----------|---------------|
| `-n, --num_rounds <num_rounds>` | Number of rounds to run the benchmark. | No | 10 |
| `model_id` | The model identifier you want to benchmark. | No | `Prompt to select from the available models` |
| `-n, --num_rounds <num_rounds>` | Number of rounds to run the benchmark. | No | `10` |
Copy link
Contributor

@freelerobot freelerobot Jun 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets separate the syntax highlighting to be more readable,

i.e. -n, --num_rounds

@irfanpena irfanpena merged commit 2a1413d into main Jun 19, 2024
1 check passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants