Skip to content

Commit

Permalink
Added build script and missing guides. Updates per review feedback
Browse files Browse the repository at this point in the history
Signed-off-by: Prasad Mujumdar <[email protected]>
  • Loading branch information
prasad-okahu committed Jul 17, 2024
1 parent 6b38a16 commit 9d740ec
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
13 changes: 6 additions & 7 deletions Monocle_User_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,24 @@

## Monocle Concepts
### Traces
Traces are the full view of a single end-to-end application KPI eg Chatbot application to provide a response to end user’s question. Traces consists of various metadata about the application run including status, start time, duration, input/outputs etc. It also includes a list of individual steps aka “spans with details about that step.
Traces are the full view of a single end-to-end application KPI, for example Chatbot application to provide a response to end user’s question. Traces consist of various metadata about the application run including status, start time, duration, input/outputs etc. They also include a list of individual steps aka “spans with details about that step.
It’s typically the workflow code components of an application that generate the traces for application runs.
### Spans
Spans are the individual steps executed by the application to perform a GenAI related task” eg app retrieving vectors from DB, app querying LLM for inference etc. The span includes the type of operation, start time, duration and metadata relevant to that step eg Model name, parameters and model endpoint/server for an inference request.
Spans are the individual steps executed by the application to perform a GenAI related task”, for example app retrieving vectors from DB, app querying LLM for inference etc. The span includes the type of operation, start time, duration and metadata relevant to that step e.g., Model name, parameters and model endpoint/server for an inference request.
It’s typically the workflow code components of an application that generate the traces for application runs.

## Setup Monocle
- You can download Monocle library releases from Pypi
```
> python3 -m pip install pipenv
> pip install monocle-observability
> pip install monocle_apptrace
```
- You can locally build and install Monocle library from source
```
> pip install .
```
- Install the optional test dependencies listed against dev in pyproject.toml in editable mode
```
> pip install -e ".[dev]"
> python3 -m pip install pipenv
> pipenv install build
```

## Examples
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The traces are compatible with OpenTelemetry format. They are further enriched t
### Try Monocle with your python genAI application
- Get latest Monocle python brary
```
pip install monocle-observability
pip install monocle_apptrace
```
- Enable Monocle tracing in your app by adding following
```
Expand Down

0 comments on commit 9d740ec

Please sign in to comment.