Skip to content

Commit

Permalink
Nit update to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mstfbl committed Sep 6, 2024
1 parent 0d88d1a commit fca3435
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 deletions.
14 changes: 6 additions & 8 deletions docs/features/system-hpo-tuning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,15 @@ For other templates, see the [Cookbooks](https://docs.nomadicml.com/get-started/

## 1. Install Nomadic

[Create a Nomadic account](app.nomadicml.com/login).

For Nomadic SDK users, your associated API keys will be provided by the Nomadic team.
To run these locally, you'll need to install the Nomadic SDK, as below:
```bash
pip install nomadic
```

<Note> As `nomadic` is currently being developed, it is not yet published to PyPI. The [current `nomadic` PyPI package](https://pypi.org/project/nomadic/) is a temporary placeholder. </Note>
To sync results with the Nomadic Workspace, you'll need a Nomadic account and an associated API key.

Install `nomadic` with the `pip` wheel provided by the Nomadic team as shown below:
<Note> The Nomadic Workspace is coming soon! Until then, please check out the [Workspace demo](https://demo.nomadicml.com). </Note>

```bash
pip install nomadic-0.0.1-py3-none-any.whl
```

## 2. Import Necessary Libraries & Configure OpenAI API Key
Import the required classes for Experiment setup, document processing, and evaluation.
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/cookbooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pip install nomadic

To sync results with the Nomadic Workspace, you'll need a Nomadic account and an associated API key.

<Note> The Nomadic Workspace is coming soon! Until then, please check out the [Workspace demo](demo.nomadicml.com). </Note>
<Note> The Nomadic Workspace is coming soon! Until then, please check out the [Workspace demo](https://demo.nomadicml.com). </Note>


## Recipes
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ pip install nomadic

To sync results with the Nomadic Workspace, you'll need a Nomadic account and an associated API key.

<Note> The Nomadic Workspace is coming soon! Until then, please check out the [Workspace demo](demo.nomadicml.com). </Note>
<Note> The Nomadic Workspace is coming soon! Until then, please check out the [Workspace demo](https://demo.nomadicml.com). </Note>


## 2. Import necessary libraries
Expand Down

0 comments on commit fca3435

Please sign in to comment.