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

Fix docs: replace --demo-project flag with --demo-projects all #858

Merged
merged 1 commit into from
Nov 17, 2023
Merged

Fix docs: replace --demo-project flag with --demo-projects all #858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,9 @@ virtualenv venv
source venv/bin/activate
```

After installing Evidently (`pip install evidently`), run the Evidently UI with the demo project:
After installing Evidently (`pip install evidently`), run the Evidently UI with the demo projects:
```
evidently ui --demo-project
evidently ui --demo-projects all
```

Access Evidently UI service in your browser. Go to the **localhost:8000**.
Expand Down
23 changes: 15 additions & 8 deletions docs/book/get-started/tutorial-monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ conda install -c conda-forge evidently

## 3. Run demo project

To launch the Evidently service with the demo project, run:
To launch the Evidently service with the demo projects, run:

```
evidently ui --demo-project
evidently ui --demo-projects all
```

## 4. View the project

To view the Evidently interface, go to URL http://localhost:8000 in your web browser.
Expand Down Expand Up @@ -277,10 +277,10 @@ Finally, launch the user interface that will include the defined project.
evidently ui
```

**4.2**. If you want to see both your new project and a standard demo project, run:
**4.2**. If you want to see both your new project and a standard demo projects, run:

```
evidently ui –-demo-project
evidently ui --demo-projects all
```

**Note**: If you already launched a demo project previously, it will remain in the workspace. There is no need to add it the second time.
Expand All @@ -293,10 +293,17 @@ evidently ui –-demo-project
evidently ui --workspace ./workspace --port 8080
```

**4.4**. If you want to see both your project and demo project in the specified workspace and run the UI service at the specific port:
**4.4**. If you want to see both your project and demo projects in the specified workspace and run the UI service at the specific port:

```
evidently ui --workspace ./workspace --port 8080 –-demo-project
```
evidently ui --workspace ./workspace --port 8080 --demo-projects all
```

**All flags**

To see all possible flags you can run evidently ui with the ```--help``` flag:
```
evidently ui --help
```

**Note**: Evidently collects anonymous telemetry about service usage. You can opt-out as described [here](../support/telemetry.md). We’d greatly appreciate it if you keep the telemetry on since it allows us to understand usage patterns and continue building useful free tools for the community.
Expand Down