mirror of
https://github.com/OS-Copilot/OS-Copilot.git
synced 2026-01-09 12:07:56 -05:00
137 lines
7.4 KiB
ReStructuredText
137 lines
7.4 KiB
ReStructuredText
.. OS-Copilot documentation master file, created by
|
|
sphinx-quickstart on Thu Feb 29 15:23:26 2024.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
:github_url: https://github.com/OS-Copilot/OS-Copilot
|
|
|
|
.. _OS-Copilot: https://os-copilot.github.io/
|
|
|
|
Introduction
|
|
==================================
|
|
|
|
.. image:: _static/demo.png
|
|
:width: 100%
|
|
:align: center
|
|
|
|
**OS-Copilot** is a pioneering conceptual framework for building generalist computer agents on Linux and MacOS, which provides a unified interface for app interactions in the heterogeneous OS ecosystem.
|
|
|
|
.. image:: _static/framework.png
|
|
:width: 100%
|
|
:align: center
|
|
|
|
Leveraging OS-Copilot, we built **FRIDAY**, a self-improving AI assistant capable of solving general computer tasks.
|
|
|
|
.. image:: _static/FRIDAY.png
|
|
:width: 100%
|
|
:align: center
|
|
|
|
**Project Homepage:** `OS-Copilot`_
|
|
|
|
|
|
Tutorials
|
|
==================================
|
|
|
|
+--------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Level | Tutorial | Description |
|
|
+==============+=================================================================================================+======================================================================================================================================+
|
|
| Beginner | `Installation <installation.html>`_ | Provides three methods to install FRIDAY: cloning from GitHub, development setup via pip install -e ., and direct pip installation. |
|
|
+--------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Beginner | `Getting Started <quick_start.html>`_ | Demonstrates how to use FRIDAY with a quick_start.py script, covering module imports, configuration setup, and task execution. |
|
|
+--------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Intermediate | `Adding Your Tools <tutorials/add_tool.html>`_ | Outlines the process for adding and removing tools to the FRIDAY. |
|
|
+--------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Intermediate | `Deploying API Services <tutorials/deploy_api_service.html>`_ | Explains the deployment of API services for FRIDAY, including environment setup, configuring API tools, and launching the server. |
|
|
+--------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Intermediate | `Example: Automating Excel Tasks <tutorials/example_excel.html>`_ | Demonstrates automating Excel tasks with FRIDAY, including formula application and chart creation within an Excel sheet. |
|
|
+--------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Intermediate | `Enhancing FRIDAY with Self-Learning for Excel Task Automation <tutorials/self_learning.html>`_ | Showcases empowering FRIDAY with self-learning to autonomously learn and execute Excel file manipulations. |
|
|
+--------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Advanced | `Designing New API Tools <tutorials/design_new_api_tool.html>`_ | Guides on designing, integrating, and deploying custom API tools for FRIDAY to extend its functionalities. |
|
|
+--------------+-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
Community
|
|
==================================
|
|
|
|
Join our community to connect with other enthusiasts, share your tools and demos, and collaborate on innovative projects. Stay engaged and get the latest updates by following us:
|
|
|
|
- **Discord**: Join our Discord server for real-time discussions, support, and to share your work with the community. Click here to join: [Discord Server](https://discord.gg/PDsRrEV27b).
|
|
- **Twitter**: Follow us on Twitter [@oscopilot](https://twitter.com/oscopilot) for the latest news, updates, and highlights from our community.
|
|
|
|
|
|
Contributing
|
|
==================================
|
|
|
|
**OS-Copilot** thrives on community contributions, and we welcome involvement in any form. Whether it's adding new tools, fixing bugs, improving documentation, or sharing ideas, every contribution counts. Join our community to advance this exciting project together!
|
|
|
|
Ways to Contribute
|
|
----------------------
|
|
|
|
- **Code:** Enhance OS-Copilot by adding new features, fixing bugs, or optimizing existing tools.
|
|
|
|
- **Documentation:** Help make OS-Copilot more accessible by improving or expanding our documentation.
|
|
|
|
- **Feedback and Ideas:** Share your insights and suggestions to make OS-Copilot even better.
|
|
|
|
- **Advocacy:** Spread the word about OS-Copilot and help grow our community.
|
|
|
|
|
|
|
|
Citation
|
|
==================================
|
|
|
|
For more detailed information about OS-Copilot and FRIDAY, please refer to our latest research paper:
|
|
|
|
.. code-block:: bibtex
|
|
|
|
@misc{wu2024oscopilot,
|
|
title={OS-Copilot: Towards Generalist Computer Agents with Self-Improvement},
|
|
author={Zhiyong Wu and Chengcheng Han and Zichen Ding and Zhenmin Weng and Zhoumianze Liu and Shunyu Yao and Tao Yu and Lingpeng Kong},
|
|
year={2024},
|
|
eprint={2402.07456},
|
|
archivePrefix={arXiv},
|
|
primaryClass={cs.AI}
|
|
}
|
|
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:maxdepth: 2
|
|
:caption: Getting Started
|
|
|
|
installation
|
|
quick_start
|
|
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:maxdepth: 2
|
|
:caption: Tutorials
|
|
|
|
tutorials/add_tool
|
|
tutorials/deploy_api_service
|
|
tutorials/design_new_api_tool
|
|
tutorials/example_excel
|
|
tutorials/self_learning
|
|
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:maxdepth: 2
|
|
:caption: Modules
|
|
|
|
agent
|
|
tool_repository
|
|
environment
|
|
utils
|
|
|
|
|
|
|
|
.. Indices and tables
|
|
.. ==================
|
|
|
|
.. * :ref:`genindex`
|
|
.. * :ref:`modindex`
|
|
.. * :ref:`search`
|