Skip to content

Commit ad51e39

Browse files
authored
Merge pull request #4 from aimonlabs/aimonp-readme-changes-patch-1
Update README.md
2 parents 324ad7b + 62d961c commit ad51e39

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
# 🎉**Welcome to AIMon Rely**
22

3-
AIMon Rely is a state-of-the-art system consisting of multiple models for detecting LLM quality issues during offline evaluations and continuous production monitoring. We offer
4-
hallucination metrics that is fast, reliable and cost-effective. We also support additional metrics such as
5-
completeness, conciseness and toxicity.
3+
AIMon Rely helps developers build, ship, and monitor LLM Apps more confidently and reliably with its state-of-the-art, multi-model system for detecting LLM quality issues. It helps seamlessly with both offline evaluations and continuous production monitoring. AIMon Rely offers fast, reliable, and cost-effective hallucination detection. It also supports other important quality metrics such as completeness, conciseness, and toxicity. Read our [blog post](https://aimon.ai/blogs/introducing-rely) for more details.
64

7-
Read our [blog post](https://aimon.ai/blogs/introducing-rely) for more details.
8-
9-
**Join our community on [Slack](https://join.slack.com/t/generativeair/shared_invite/zt-2jab62lsj-xM9a_s~Qweu8lf3YS2cANg)
10-
or reach out to us at info@aimon.ai to get your API key.**
5+
**Join our community on [Slack](https://join.slack.com/t/generativeair/shared_invite/zt-2jab62lsj-xM9a_s~Qweu8lf3YS2cANg)**
116

127
<div align="center">
13-
<img src="images/aimon-rely-image.png" alt="AIMon Rely" width="550" height="450">
8+
<img src="images/aimon-rely-image.png" alt="AIMon Rely" width="450" height="350">
149
</div>
1510

1611
## Metrics Supported
1712

18-
These are the quality metrics that are currently available via the API. Some of them are in progress and will be
19-
available in a future release.
13+
The following is a list of quality metrics that are currently available and on our roadmap. Please reach out to express your interest in any of these.
2014

2115
| Metric | Status |
2216
|--------------------------------------------------|--------------------------------------------------------------|
@@ -32,22 +26,24 @@ available in a future release.
3226

3327
## Getting Started
3428

35-
### SDK and UI
29+
You can use AIMon either through an SDK or through an API. Below you will find instructions on 1. how to use the SDK along with AIMon's UI and 2. how you could use it directly through our REST APIs.
30+
31+
### 1. SDK and UI
3632

3733
AIMon supports asynchronous instrumentation or synchronous detections for the metrics mentioned above. Use these steps
3834
to get started with using the AIMon SDK and the product.
3935

40-
- Step 1: Get access to the beta product by joining the wait list on our [website](https://aimon.ai/) or by requesting
36+
- Step 1: Get access to the beta product by joining the waitlist on our [website](https://aimon.ai/) or by requesting
4137
it on [Slack](https://join.slack.com/t/generativeair/shared_invite/zt-2jab62lsj-xM9a_s~Qweu8lf3YS2cANg) or sending an email to info@aimon.ai
4238
- Step 2: Install the AIMon SDK by running `pip install aimon` in your terminal.
43-
- Step 3: Refer to the [sample notebook](examples/notebooks/aimon_sdk_langchain_summarization.ipynb) for an example of how to instrument an LLM application asynchronously using the SDK.
44-
You can also refer to the sample [streamlit application](examples/langchain_summarization_app.py) for an example for synchronous detections.
39+
- Step 3: For an example of how to instrument an LLM application **asynchronously** using the SDK, please refer to the [sample notebook](examples/notebooks/aimon_sdk_langchain_summarization.ipynb)
40+
- Step 4: For an example of synchronous detections using the SDK, please refer to the sample [streamlit application](examples/langchain_summarization_app.py)
4541

4642
<div align="center">
4743
<img src="images/product_apps_page.png" alt="AIMon Product">
4844
</div>
4945

50-
### API
46+
### 2. API
5147

5248
AIMon detections can be accessed via REST APIs. Here are the steps to access the API:
5349

@@ -75,7 +71,7 @@ A few key takeaways:
7571

7672
✅ Support for a context length of up to 32,000 tokens (with plans to further expand this in the near future).
7773

78-
Overall, AIMon Rely is 10 times cheaper, 4 times faster and close to or even **better than GPT-4** on the benchmarks
74+
Overall, AIMon Rely is 10 times cheaper, 4 times faster, and close to or even **better than GPT-4** on the benchmarks
7975
making it a suitable choice for both offline and online detection of hallucinations.
8076

8177
<div align="center">
@@ -84,7 +80,7 @@ making it a suitable choice for both offline and online detection of hallucinati
8480

8581
### Completeness, Conciseness Detection
8682

87-
There is a lack of industry standard benchmark datasets for these metrics. We will be publishing an evaluation dataset soon.
83+
There is a lack of industry-standard benchmark datasets for these metrics. We will be publishing an evaluation dataset soon.
8884
Stay Tuned! <span style="font-size: 16px;">⌛</span>
8985

9086
## Pricing
@@ -97,4 +93,4 @@ Please reach out to info@aimon.ai for pricing details related to the product and
9793
- In addition, we are working on something awesome to make the offline evaluation and continuous model quality
9894
monitoring experience more seamless.
9995

100-
Join our [Slack](https://join.slack.com/t/generativeair/shared_invite/zt-2jab62lsj-xM9a_s~Qweu8lf3YS2cANg) for the latest updates and discussions on generative AI reliability.
96+
Join our [Slack](https://join.slack.com/t/generativeair/shared_invite/zt-2jab62lsj-xM9a_s~Qweu8lf3YS2cANg) for the latest updates and discussions on generative AI reliability.

0 commit comments

Comments
 (0)