# Venture ✨ 🧑🚀 ✨
## 🚀 Your AI-powered project exploration
``Venture`` let's you to explore and ask questions to your project documentations.
[](https://twitter.com/roysadaka)
[](https://badge.fury.io/py/venture-ai)
[](https://pepy.tech/project/venture-ai)
## For latest PyPI stable release
```sh
pip install venture-ai
```
---
## 🛰️ Mission Control
``Venture`` sets out to be a devoted companion for developers and other team members in an organization.
It serves as an assistant to assist with diverse inquiries concerning projects, protocols, conventions, and any documented details.
This tool promotes seamless sharing and retrieval of knowledge, fostering teamwork, problem-solving, and collaboration within teams.
Just like a cosmic entity, ``Venture`` harnesses the power of OpenAI's ChatGPT to embark on this journey.
```python
from venture import Venture
if __name__ == '__main__':
v = Venture(openai_api_key='sk-...', # OBTAINED FROM https://platform.openai.com/account/api-keys
captain_email='captain@spaceship.com', # THE DEFAULT CONTACT IN INTERLINK TAB
extra_role='You are an AI assistant for Venture Company.', # ANY INFO ABOUT YOUR SPECIFIC USE CASE
cosmos_path='/Users/captain/Documents/MyVenture/', # Optional, THE PATH TO STORE THE PARSED DOCUMENTS AND INTERNAL INDEXING
share=False) # FOR SHARING THE APP LINK OUTSIDE YOUR LOCAL NETWORK
v.launch()
```
After initiating the launch, ``Venture``, powered by Gradio, will generate a cosmic link that enables you to activate the application.
Effortlessly navigate to the bestowed link amidst the vastness of your web browser's galaxy.
```sh
Running on local URL: http://127.0.0.1:7860
```
With ``share=True``, you will receive a cosmic link that grants you access to a public space where you can share your project beyond your local network.
Keep in mind that the mentioned expiration time may vary like distant stars in the galaxy.
```sh
Running on public URL: https://3c10d1b4393cd966cd.gradio.live
This share link expires in 72 hours.
```
---
## 💫 A Cosmic Journey
In the celestial realm of the web app, ``Venture`` unveils its enchanting interface.
Prepare to embark on a cosmic journey through its three celestial tabs, each designed to guide you through the depths of your project documentation and beyond.
1. 🧑🚀 Explore Tab: Unveil the Secrets of the Cosmos
This ethereal tab serves as your portal to the wonders of project documentation.
In it, ``Venture`` eagerly awaits your inquiries and questions.
Discover the vast knowledge it holds or let its "Auto-Pilot" feature autonomously guide you to the precise documentation you seek.
2. 🌟 Cosmos Tab: Forge New Stars in the Galaxy
In this celestial workshop, you possess the power to shape the very fabric of your cosmos.
Add new constellations of knowledge to the cosmic expanse or remove existing ones as you navigate through the possibilities of your documentation universe.
3. 📡 Interlink Tab: Communication Across the Stars
This celestial conduit bridges the gap between you and the support team, ensuring seamless communication amidst the cosmic expanse.
Should you encounter enigmatic anomalies or deem a documentation update necessary, harness the power of the Interlink Tab to connect with the support team, who will guide you through the celestial seas of knowledge.
---
## 🔍 Reasoning Based Search
When using 'Auto-Pilot' mode in 📌 Cosmos, ``Venture`` performs a document search.
Its goal is to find the most suitable document for the user's query.
Instead of relying on traditional search techniques, ``Venture`` employs a novel approach.
For each document added to the ``Cosmos``, metadata such as file name, summary, and owner is extracted.
Venture then utilizes the 'function call' feature of ChatGPT to generate dynamic functions based on this metadata.
By leveraging the reasoning capabilities of ChatGPT, ``Venture`` performs a ChatGPT 'function call' with all the docs metadata.
### 🛑 Limitations:
While ``Venture`` presents a powerful tool for document navigation and search, its current iteration has a few limitations, particularly related to the volume of documents it can effectively handle.
In its present version, Reasoning Based Search in ``Venture`` can effectively support only up to approximately 300 documents.
A ChatGPT function call for this search method will be triggered for every ~70 documents.
We're investing our efforts in creating the next version of ``Venture``, which will considerably expand the tool's capabilities to handle search across thousands of documents effectively.
If you're dealing with a greater volume of documents, we recommend segmenting them and creating multiple instances of ``Venture`` where each instance caters to a specific subset of your documents.
### 🤔 Why no embeddings?
While embeddings are amazing, they also carry certain inherent limitations that influenced our decision not to implement them in ``Venture``.
* **Limited context for short texts:** Embeddings Based Search can struggle with short texts due to the lack of context, leading to potential inaccuracies in the search results.
* **Noisiness for long texts:** conversely, long texts can introduce too much noise in the embeddings, again resulting in less precise matches.
* **Challenges with Antonyms:** Embeddings often conflate words with opposite meanings, like "good" and "bad", that appear in similar contexts, incorrectly positioning them close together in the vector space.
* **Lack of indication for no relevant results:** one major drawback of Embeddings Based Search methods (like cosine or p2 distance) is their inability to signal when no relevant results are found.
Though certain techniques like thresholds and metadata enhancements can somewhat ameliorate this issue, the problem remains.
Our (humble) research has led us to the conclusion that a Reasoning Based Search, underpinned by a robust language model like ChatGPT, is more accurate, bypassing the issues raised above.
However, it's important to note that despite its increased accuracy, Reasoning Based Search is much slower than Embeddings Based Search and is not (yet) scalable to thousands of documents in its current form.
---
## ⚡️ Cosmic Responsibility
You hold the cosmic responsibility for your interactions with ``Venture``, just as you hold the responsibility for handling any powerful tool.
Sharing any content generated by ``Venture`` is equivalent to sharing it on your own behalf.
It is important to note that documents containing sensitive information should be avoided as they will be parsed by ChatGPT.
Exercise caution and ensure that you only include non-sensitive and appropriate content in the documents used with ``Venture``.
---
## 📡 Caught in an interstellar void? Transmit an inquiry!
If you feel that there's something amiss in our celestial realm, we encourage you to reach out. You have a couple of options to connect with us:
1. Open an Issue: If you come across any anomalies or have suggestions for improvements, you can open an issue.
Our team will promptly address it and ensure the cosmic balance is restored.
2. Email us: Feel free to send us an email at torch.lpd@gmail.com.
We welcome your thoughts, ideas, and any other cosmic communication you wish to share with us.
Together, we can enhance ``Venture`` and embark on an even more remarkable cosmic journey!
---
## 🔭 Stellar Visuals, Unveiling the Interface
Behold these mesmerizing cosmic captures, offering a tantalizing preview of the celestial user interface.
The version depicted here may exhibit slight variations from the released solutions, akin to the ever-shifting starry night-sky.
#### 🧑🚀 Explore Tab
---
#### 🌟 Cosmos Tab
---
#### 📡 Interlink Tab
Raw data
{
"_id": null,
"home_page": "https://github.com/roysadaka/venture",
"name": "venture-ai",
"maintainer": "lpd developers",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "torch.lpd@gmail.com",
"keywords": "ai,natural language processing,large language models,project exploration,chatbot,documentation exploration,reasoning based search,assistant,chatgpt,openai",
"author": "Roy Sadaka",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/72/25/93ef6ce39a24e35cfd7bab85baefc2bd8b678ecf02ea39c8f88fead1621f/venture-ai-0.9.9.tar.gz",
"platform": null,
"description": "# Venture \u2728 \ud83e\uddd1\u200d\ud83d\ude80 \u2728\n\n\n\n## \ud83d\ude80 Your AI-powered project exploration\n\n\n``Venture`` let's you to explore and ask questions to your project documentations. \n\n[](https://twitter.com/roysadaka)\n\n[](https://badge.fury.io/py/venture-ai) \n[](https://pepy.tech/project/venture-ai)\n\n## For latest PyPI stable release \n\n```sh\n pip install venture-ai\n```\n\n---\n\n## \ud83d\udef0\ufe0f Mission Control\n``Venture`` sets out to be a devoted companion for developers and other team members in an organization. \nIt serves as an assistant to assist with diverse inquiries concerning projects, protocols, conventions, and any documented details. \nThis tool promotes seamless sharing and retrieval of knowledge, fostering teamwork, problem-solving, and collaboration within teams. \nJust like a cosmic entity, ``Venture`` harnesses the power of OpenAI's ChatGPT to embark on this journey.\n\n\n```python\nfrom venture import Venture\n\nif __name__ == '__main__':\n v = Venture(openai_api_key='sk-...', # OBTAINED FROM https://platform.openai.com/account/api-keys\n captain_email='captain@spaceship.com', # THE DEFAULT CONTACT IN INTERLINK TAB \n extra_role='You are an AI assistant for Venture Company.', # ANY INFO ABOUT YOUR SPECIFIC USE CASE\n cosmos_path='/Users/captain/Documents/MyVenture/', # Optional, THE PATH TO STORE THE PARSED DOCUMENTS AND INTERNAL INDEXING\n share=False) # FOR SHARING THE APP LINK OUTSIDE YOUR LOCAL NETWORK\n v.launch()\n```\n\nAfter initiating the launch, ``Venture``, powered by Gradio, will generate a cosmic link that enables you to activate the application. \nEffortlessly navigate to the bestowed link amidst the vastness of your web browser's galaxy.\n```sh\n Running on local URL: http://127.0.0.1:7860\n```\n\nWith ``share=True``, you will receive a cosmic link that grants you access to a public space where you can share your project beyond your local network. \nKeep in mind that the mentioned expiration time may vary like distant stars in the galaxy. \n```sh\n Running on public URL: https://3c10d1b4393cd966cd.gradio.live\n This share link expires in 72 hours.\n```\n\n---\n\n## \ud83d\udcab A Cosmic Journey\nIn the celestial realm of the web app, ``Venture`` unveils its enchanting interface. \nPrepare to embark on a cosmic journey through its three celestial tabs, each designed to guide you through the depths of your project documentation and beyond.\n\n1. \ud83e\uddd1\u200d\ud83d\ude80 Explore Tab: Unveil the Secrets of the Cosmos \n This ethereal tab serves as your portal to the wonders of project documentation. \n In it, ``Venture`` eagerly awaits your inquiries and questions. \n Discover the vast knowledge it holds or let its \"Auto-Pilot\" feature autonomously guide you to the precise documentation you seek.\n\n2. \ud83c\udf1f Cosmos Tab: Forge New Stars in the Galaxy \n In this celestial workshop, you possess the power to shape the very fabric of your cosmos. \n Add new constellations of knowledge to the cosmic expanse or remove existing ones as you navigate through the possibilities of your documentation universe.\n\n3. \ud83d\udce1 Interlink Tab: Communication Across the Stars \n This celestial conduit bridges the gap between you and the support team, ensuring seamless communication amidst the cosmic expanse. \n Should you encounter enigmatic anomalies or deem a documentation update necessary, harness the power of the Interlink Tab to connect with the support team, who will guide you through the celestial seas of knowledge.\n\n---\n\n\n\n## \ud83d\udd0d Reasoning Based Search\nWhen using 'Auto-Pilot' mode in \ud83d\udccc Cosmos, ``Venture`` performs a document search. \nIts goal is to find the most suitable document for the user's query. \nInstead of relying on traditional search techniques, ``Venture`` employs a novel approach.\n\nFor each document added to the ``Cosmos``, metadata such as file name, summary, and owner is extracted. \nVenture then utilizes the 'function call' feature of ChatGPT to generate dynamic functions based on this metadata. \nBy leveraging the reasoning capabilities of ChatGPT, ``Venture`` performs a ChatGPT 'function call' with all the docs metadata.\n\n### \ud83d\uded1 Limitations:\nWhile ``Venture`` presents a powerful tool for document navigation and search, its current iteration has a few limitations, particularly related to the volume of documents it can effectively handle.\n\nIn its present version, Reasoning Based Search in ``Venture`` can effectively support only up to approximately 300 documents. \nA ChatGPT function call for this search method will be triggered for every ~70 documents. \n\nWe're investing our efforts in creating the next version of ``Venture``, which will considerably expand the tool's capabilities to handle search across thousands of documents effectively. \n\nIf you're dealing with a greater volume of documents, we recommend segmenting them and creating multiple instances of ``Venture`` where each instance caters to a specific subset of your documents.\n\n\n### \ud83e\udd14 Why no embeddings?\nWhile embeddings are amazing, they also carry certain inherent limitations that influenced our decision not to implement them in ``Venture``. \n\n* **Limited context for short texts:** Embeddings Based Search can struggle with short texts due to the lack of context, leading to potential inaccuracies in the search results.\n\n* **Noisiness for long texts:** conversely, long texts can introduce too much noise in the embeddings, again resulting in less precise matches.\n\n* **Challenges with Antonyms:** Embeddings often conflate words with opposite meanings, like \"good\" and \"bad\", that appear in similar contexts, incorrectly positioning them close together in the vector space.\n\n* **Lack of indication for no relevant results:** one major drawback of Embeddings Based Search methods (like cosine or p2 distance) is their inability to signal when no relevant results are found. \nThough certain techniques like thresholds and metadata enhancements can somewhat ameliorate this issue, the problem remains.\n\nOur (humble) research has led us to the conclusion that a Reasoning Based Search, underpinned by a robust language model like ChatGPT, is more accurate, bypassing the issues raised above.\n\nHowever, it's important to note that despite its increased accuracy, Reasoning Based Search is much slower than Embeddings Based Search and is not (yet) scalable to thousands of documents in its current form. \n\n\n---\n\n\n## \u26a1\ufe0f Cosmic Responsibility\nYou hold the cosmic responsibility for your interactions with ``Venture``, just as you hold the responsibility for handling any powerful tool. \nSharing any content generated by ``Venture`` is equivalent to sharing it on your own behalf. \nIt is important to note that documents containing sensitive information should be avoided as they will be parsed by ChatGPT. \nExercise caution and ensure that you only include non-sensitive and appropriate content in the documents used with ``Venture``.\n\n---\n\n## \ud83d\udce1 Caught in an interstellar void? Transmit an inquiry!\nIf you feel that there's something amiss in our celestial realm, we encourage you to reach out. You have a couple of options to connect with us:\n\n1. Open an Issue: If you come across any anomalies or have suggestions for improvements, you can open an issue. \n Our team will promptly address it and ensure the cosmic balance is restored.\n\n2. Email us: Feel free to send us an email at torch.lpd@gmail.com. \n We welcome your thoughts, ideas, and any other cosmic communication you wish to share with us.\n\nTogether, we can enhance ``Venture`` and embark on an even more remarkable cosmic journey!\n\n---\n\n## \ud83d\udd2d Stellar Visuals, Unveiling the Interface\nBehold these mesmerizing cosmic captures, offering a tantalizing preview of the celestial user interface. \nThe version depicted here may exhibit slight variations from the released solutions, akin to the ever-shifting starry night-sky.\n\n#### \ud83e\uddd1\u200d\ud83d\ude80 Explore Tab\n \n\n---\n\n#### \ud83c\udf1f Cosmos Tab\n \n\n---\n\n#### \ud83d\udce1 Interlink Tab\n \n",
"bugtrack_url": null,
"license": "MIT Licences",
"summary": "A Fast, Flexible Trainer with Callbacks and Extensions for PyTorch",
"version": "0.9.9",
"project_urls": {
"Homepage": "https://github.com/roysadaka/venture"
},
"split_keywords": [
"ai",
"natural language processing",
"large language models",
"project exploration",
"chatbot",
"documentation exploration",
"reasoning based search",
"assistant",
"chatgpt",
"openai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85ef28f5023ce0ee2fd8099d3d2e2a49fe8c6064b60adff746e65134f5f6fdff",
"md5": "ca6be43a46d55a915f307dbfca6ae010",
"sha256": "b19c6d0b490bde549b085cdace98798ca945c14f429d029a35600d0ef4603eb5"
},
"downloads": -1,
"filename": "venture_ai-0.9.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca6be43a46d55a915f307dbfca6ae010",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 40823,
"upload_time": "2023-07-19T17:17:08",
"upload_time_iso_8601": "2023-07-19T17:17:08.284435Z",
"url": "https://files.pythonhosted.org/packages/85/ef/28f5023ce0ee2fd8099d3d2e2a49fe8c6064b60adff746e65134f5f6fdff/venture_ai-0.9.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "722593ef6ce39a24e35cfd7bab85baefc2bd8b678ecf02ea39c8f88fead1621f",
"md5": "2d0b66291f5cc777ecdd92ae5dc735a5",
"sha256": "f5dfb86bc1e142da9ae2d82e3d0909f6b9ffde957dd1e1241219927f84fb53b7"
},
"downloads": -1,
"filename": "venture-ai-0.9.9.tar.gz",
"has_sig": false,
"md5_digest": "2d0b66291f5cc777ecdd92ae5dc735a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 34937,
"upload_time": "2023-07-19T17:17:10",
"upload_time_iso_8601": "2023-07-19T17:17:10.256541Z",
"url": "https://files.pythonhosted.org/packages/72/25/93ef6ce39a24e35cfd7bab85baefc2bd8b678ecf02ea39c8f88fead1621f/venture-ai-0.9.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-19 17:17:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "roysadaka",
"github_project": "venture",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "venture-ai"
}
JSON
