Orano (Ontology-driven Reasoning with AI for Natural Operations) Bot Project
STILL IN IDEATION PHASE

A library to benchmark various Large Language Models (LLMs) by receiving a prompt from the user, converting it into step-by-step actions, and interacting with a computer environment.

Explore the Docs »

Report Bug · Request Feature

---

Table of Contents

1. Key Modules
2. Project Status
3. Devlog
4. Directory Structure
5. Getting Started
   • Clone the Repo
   • Install Dependencies
   • Run Basic Tests
6. Contributing
7. License
8. Contact

---

Key Modules

1. Vision

   • Captures screenshots and detects objects (e.g., buttons, windows, text fields).
   • Provides metadata about screen elements.

2. Mind

   • Manages prompt handling and interaction with one or more LLMs.
   • Breaks user requests into smaller, sequenced commands.

3. OranoBot

   • Orchestrates the workflow:
     • Accepts user prompts.
     • Calls Mind to generate actions.
     • Uses Vision to provide environment context (screenshots).
     • Executes each step on the computer.

4. UI (Optional)

   • Helper module for user-interface operations, hooking into the OS or external libraries for automation.

(back to top)

---

Project Status

• Just Started: The code structure is set up, but actual implementations are minimal or placeholders.
• MLOps: Will be integrated later for continuous model training/deployment, if needed.
• Docker & AWS: Planned, but not implemented yet.

(back to top)

---

Devlog

• We maintain a development log in the devlog/ folder.
  • Each date has its own .md file (e.g., devlog_2024_12_30.md).
  • The latest development notes and images are there.
• We may occasionally highlight the most recent devlog entries here in the main README.
• You can also follow the project on Medium.

(back to top)

---

Directory Structure

orano/
├── .gitignore
├── LICENSE
├── README.md
├── devlog/
│   └── imgs/
├── docs/
│   └── architecture.md
├── requirements.txt
├── src/
│   └── orano/
│       ├── __init__.py
│       ├── mind.py
│       ├── vision.py
│       ├── bot.py
│       └── ui.py
└── tests/
    ├── __init__.py
    ├── test_mind.py
    ├── test_vision.py
    ├── test_bot.py
    └── test_ui.py

Notes:

• src/orano/ houses your main code modules.
• tests/ contains unit tests for each module.
• devlog/ stores the development journal and images.

(back to top)

---

Getting Started

Clone the Repo

git clone https://github.com/Gabriel382/orano.git
cd orano

Install Dependencies

pip install -r requirements.txt

(If you prefer Poetry or Conda, adjust accordingly.)

Run Basic Tests

pytest tests

(Or your test runner of choice.)

Check out the devlog/ for detailed progress notes and any relevant screenshots or diagrams.

(back to top)

---

Contributing

• Check out our LICENSE to see how this project is distributed.
• Feel free to open issues or pull requests if you have ideas or bug fixes.
• As we grow, we’ll add a CONTRIBUTING.md for guidelines and best practices.

(back to top)

---

License

This project is licensed under the MIT License. Please see the license file for full details.

(back to top)

---

Contact

Gabriel Henrique Alencar Medeiros

• LinkedIn Profile
• GitHub Repository

(back to top)

---

Happy Building!
Stay tuned for updates, and check our devlog for day-to-day progress.