You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-18Lines changed: 14 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,16 @@
1
1
# 🎉**Welcome to AIMon Rely**
2
2
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 and related metrics. 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.
6
4
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)**
@@ -32,22 +26,24 @@ available in a future release.
32
26
33
27
## Getting Started
34
28
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
36
32
37
33
AIMon supports asynchronous instrumentation or synchronous detections for the metrics mentioned above. Use these steps
38
34
to get started with using the AIMon SDK and the product.
39
35
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
41
37
it on [Slack](https://join.slack.com/t/generativeair/shared_invite/zt-2jab62lsj-xM9a_s~Qweu8lf3YS2cANg) or sending an email to info@aimon.ai
42
38
- 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)
@@ -97,4 +93,4 @@ Please reach out to info@aimon.ai for pricing details related to the product and
97
93
- In addition, we are working on something awesome to make the offline evaluation and continuous model quality
98
94
monitoring experience more seamless.
99
95
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