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

Jump to bottom

Incorporated the suggested changes in README.md #985

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Incorporated the suggested changes in README.md #985

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f196c92
Changes applied to readme.md
thakurboy004 Oct 27, 2024
5c9d778
Added back to top links for a better naviagtion in the readme.md file
thakurboy004 Oct 27, 2024
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
38 changes: 35 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[![Twitter Follow](https://img.shields.io/twitter/follow/AskMarvinAI?style=social)](https://twitter.com/AskMarvinAI)

# Marvin
<a name="top"></a>

### The AI engineering toolkit

Expand All @@ -20,6 +21,9 @@ Marvin aims to merge the best practices for building dependable, observable soft

Marvin is open-source, free to use, and made with 💙 by the team at [Prefect](https://www.prefect.io/).


[⬆️ Back to top](#top)

## Installation

Install the latest version with `pip`:
Expand All @@ -30,10 +34,13 @@ pip install marvin -U

To verify your installation, run `marvin version` in your terminal.


## Tools

Marvin consists of a variety of useful tools, all designed to be used independently. Each one represents a common LLM use case, and packages that power into a simple, self-documenting interface.

[⬆️ Back to top](#top)

### General

🦾 [Write custom AI-powered functions](https://askmarvin.ai/docs/text/functions) without source code
Expand Down Expand Up @@ -78,6 +85,8 @@ Marvin consists of a variety of useful tools, all designed to be used independen

🧭 [Build applications](https://askmarvin.ai/docs/interactive/applications) that manage persistent state

[⬆️ Back to top](#top)

# Quickstart

Here's a whirlwind tour of a few of Marvin's main features. For more information, [check the docs](https://askmarvin.ai/welcome/what_is_marvin/)!
Expand Down Expand Up @@ -200,6 +209,8 @@ Location("The Big Apple")

Learn more about casting to types [here](https://askmarvin.ai/docs/text/transformation).

[⬆️ Back to top](#top)

## 🦾 Build AI-powered functions

Marvin functions let you combine any inputs, instructions, and output types to create custom AI-powered behaviors... without source code. These functions can go well beyond the capabilities of `extract` or `classify`, and are ideal for complex natural language processing or mapping combinations of inputs to outputs.
Expand All @@ -222,6 +233,8 @@ Note that Marvin does NOT work by generating or executing source code, which wou

You can learn more about functions [here](https://www.askmarvin.ai/docs/text/functions/).

[⬆️ Back to top](#top)

## 🖼️ Generate images from text

Marvin can `paint` images from text:
Expand Down Expand Up @@ -273,10 +286,29 @@ ai_audio = marvin.speak(ai_text)
ai_audio.play()
```


[⬆️ Back to top](#top)

# Get in touch!

💡 **Feature idea?** share it in the `#development` channel in [our Discord](https://discord.com/invite/Kgw4HpcuYG).
## Reporting Vulnerabilities

We take security seriously and encourage users to report any vulnerabilities. Please follow these guidelines to ensure a safe and efficient disclosure process.

### Reporting a Bug or Vulnerability

🐛 **Found a bug?** If you've identified a bug that might pose a security risk, please [open an issue](https://github.com/PrefectHQ/marvin/issues/new/choose) to inform us. We’ll work to address it as quickly as possible. For security-related issues, please mark the issue as "confidential" to limit visibility.

### Feature Requests

💡 **Have a feature idea?** We’re open to new ideas for Marvin's development. Share your suggestions in the `#development` channel on [our Discord](https://discord.com/invite/Kgw4HpcuYG), and let us know how we can make Marvin better.

### General Feedback

👷 **Got feedback?** Marvin is under active development, and your feedback is valuable. Join [our discussions](https://github.com/PrefectHQ/marvin/discussions) on GitHub to share your thoughts or improvements.

## Contact Us

🐛 **Found a bug?** feel free to [open an issue](https://github.com/PrefectHQ/marvin/issues/new/choose).
For urgent security concerns, please reach out via [our Discord](https://discord.com/invite/Kgw4HpcuYG) or submit a report on GitHub. We appreciate the community's support in helping us keep Marvin secure and continuously improving.

👷 **Feedback?** Marvin is under active development, and we'd love to [hear it](https://github.com/PrefectHQ/marvin/discussions).
[⬆️ Back to top](#top)