[FR] : AI Writers - Githubissues

yatendra2001 commented 1 year ago

Description

AI-powered writing assistant using Flutter and the GPT-4 model from OpenAI. The assistant, tentatively named "AI Writers", will assist users in generating and organizing content efficiently. This includes automatic to-do list generation, blog post drafting, and outline creation.

Similar to the notion AI, we can keep a button or just press space for "ask AI"

Timeline:

Week 1 (19/06/2023):

Tasks:

[x] Research and Understand GPT-4
[x] Understand appflowy coding practices.
[x] Research if there are existing Rust libraries that wrap GPT-4

Milestones:

Gain a comprehensive understanding of GPT-4 capabilities and functionalities
Gain in depth understanding of appflowy best coding practices integrated in CI/CD.
Determine if there are existing Rust libraries available for GPT-4 integration

Week 2 (26/06/2023):

Tasks:

[x] Develop first working version of Rust wrapper for OpenAI API
[x] Initiate exploration of AppFlowy backend system

Milestones:

Develop a basic Rust wrapper for OpenAI API with minimal functionality
Understand basic structure and components of AppFlowy backend

Week 3 (03/07/2023):

Tasks:

[x] Gain deeper understanding of Creating Systems with OpenAI API
[x] Gain deeper understanding of prompt engineering to develop applications

Milestone:

Build an end-to-end demo system using gpt-4 with proper prompting

Week 4 (10/07/2023):

Tasks:

[x] Enhance Rust wrapper for OpenAI API with additional features
[x] Delve deeper into the complexities of AppFlowy backend
[x] Fix issue #2937 row banner overlay.

Milestones:

Upgrade Rust wrapper for OpenAI API with advanced features
Gain a deep understanding of AppFlowy backend, including data flows and dependencies
Raise a PR for issue. (raised pr: #3009)

Week 5 (17/07/2023):

Tasks:

[x] Finalize application design and user interface
[x] Start integration of GPT-4 Rust Wrapper with backend
[x] Complete the integration of GPT-4 Rust Wrapper with backend
[x] Begin development of auto-generating to-do list feature

Milestones:

Finalize application design and UI.
Begin the process of integrating GPT-4 Rust Wrapper with rust backend structure.
Successfully integrate GPT-4 Rust Wrapper with rust backend structure.
Initiate the development of the to-do list feature.

Week 6 (24/07/2023):

Tasks:

[x] Continue development of the to-do list feature
[x] Start development of the outline creation feature

Milestones:

Complete the development of the to-do list feature
Initiate the development of the outline creation feature

Midterm Valuation

Gained comprehensive understanding of GPT-4 and AppFlowy's coding practices.
Identified potential Rust libraries for GPT-4 integration.
Developed a basic Rust wrapper for OpenAI API.
Explored AppFlowy's backend structure.
Built a demo system using GPT-4 with proper prompting.
Enhanced Rust wrapper for OpenAI API with advanced features.
Delved deeper into AppFlowy's backend complexities.
Resolved a bug in AppFlowy (PR: #3009).
Finalised application design and UI (similar to Notion AI).
Initiated and completed GPT-4 Rust Wrapper integration with backend.
Began development of auto-generating to-do list feature and completed it.
Initiated development of outline creation feature.

Week 7 (31/07/2023):

Tasks:

[x] Make Rust wrapper API code modular and scalable.
[x] Write comprehensive tests for the API with 100% coverage.

Milestones:

Achieve modular and scalable Rust wrapper API code.
Completed tests for the API with 100% coverage.

Week 8 (07/08/2023):

Tasks:

[ ] Build the frontend Flutter interface.
[ ] Write thorough tests for the complete interface.
[x] Gain a clear understanding of the backend-to-frontend integration flow.

Milestones:

Completed and polished frontend Flutter interface.
Full test coverage for the entire frontend interface.
Deep understanding of the integration flow from backend to frontend.

Week 9 (14/08/2023):

Tasks:

[ ] Address and resolve the Evernote importer issue (#2971).
[ ] Integrate the Rust wrapper API with the Flutter frontend interface.
[ ] Write comprehensive tests for the integrated system.

Milestones:

Successfully fixed the Evernote importer issue (#2971).
Successful integration of the Rust wrapper API with the Flutter frontend.
Completed tests for the integrated system.

Week 10 (21/08/2023):

Tasks:

[ ] Test the complete project end-to-end to ensure seamless functionality.
[ ] Address and fix any bugs or issues that may arise during testing.
[ ] Begin migration of current OpenAI features on Flutter side to using Rust wrapper

Milestones:

Complete the project documentation
Address and fix any bugs or issues that may arise during testing.
Initiate the migration of current OpenAI features to using Rust wrapper

Week 11 (28/08/2023):

Tasks:

[ ] Finalize migration of current OpenAI features on Flutter side to using Rust wrapper
[ ] Continue comprehensive testing and debugging of the application
[ ] Resolve any remaining issues identified during final testing

Milestones:

Successfully migrate all current OpenAI features to use Rust wrapper
Continue comprehensive testing and debugging of the entire application
Ensure all identified issues are resolved and application is fully functional

Week 12 (04/09/2023):

Tasks:

[ ] Finalize and review the entire project, ensuring all tasks are completed satisfactorily.
[ ] Prepare the application for live deployment
[ ] Document the complete project in a detailed blog, covering architecture, development process, and usage instructions.

Milestones: 30.Successful project review and preparation for final live deployment.

Successfully prepare the application for deployment, with all features working as expected
Completion of a comprehensive blog documenting the entire project.

Impact

The successful implementation of this project will provide a powerful tool for users who require assistance with various writing tasks. By automating these tasks, users can focus more on their ideas and less on the mechanical aspects of writing.

Given the increasing demand for AI-powered tools and the widespread use of mobile devices, this project can potentially benefit a wide range of users.

Additional Context

No response

yatendra2001 commented 1 year ago

@LucasXu0 Can you please review this?

LucasXu0 commented 1 year ago

Hey, @yatendra2001. It looks good to me. By the way, please add one more task: migrate the current openAI features by using Rust wrapper too.

enum OpenAIRequestType {
  textCompletion,
  textEdit;

  Uri get uri {
    switch (this) {
      case OpenAIRequestType.textCompletion:
        return Uri.parse('https://api.openai.com/v1/completions');
      case OpenAIRequestType.textEdit:
        return Uri.parse('https://api.openai.com/v1/edits');
    }
  }
}

LucasXu0 commented 1 year ago

We are currently using text completion and text edit APIs on the Flutter side. We should migrate them to Rust APIs once you finish this FR.

yatendra2001 commented 1 year ago

Hey, @yatendra2001. It looks good to me. By the way, please add one more task: migrate the current openAI features by using Rust wrapper too.
enum OpenAIRequestType {
  textCompletion,
  textEdit;

  Uri get uri {
    switch (this) {
      case OpenAIRequestType.textCompletion:
        return Uri.parse('https://api.openai.com/v1/completions');
      case OpenAIRequestType.textEdit:
        return Uri.parse('https://api.openai.com/v1/edits');
    }
  }
}

Yes makes a lot of sense.

We are currently using text completion and text edit APIs on the Flutter side. We should migrate them to Rust APIs once you finish this FR.

Yup added at the end. We'll keep adding subtasks of migration as we figure out to keep a record.

annieappflowy commented 1 year ago

yatendra2001 commented 1 year ago

Hi @annieappflowy, @LucasXu0,

I'm looking forward to contributing to this project and am ready to start working on the issue at hand. However, I want to make sure I align with the selection process properly. Should I wait for the proposal to be accepted before proceeding, or is it acceptable to begin in advance? This is particularly important as I have outlined a timeline in my proposal.

annieappflowy commented 1 year ago

I've sent an official letter to you! You may start working on your project. Congrats!

yatendra2001 commented 1 year ago

Thanks a lot, @annieappflowy for accepting my proposal. You can bet I'll be bringing my A-game to this mentorship.

yatendra2001 commented 1 year ago

Hey @LucasXu0 , Should I create a new PR now to keep you updated of my tasks or once my first commit is ready to get merged??

LucasXu0 commented 1 year ago

@yatendra2001 No, we can communicate with them via video meeting, just like we did previously.

lybing commented 1 year ago

When the network is abnormal, keep circling and need to close the software to exit. Snipaste_2023-08-02_23-10-07

AppFlowy-IO / AppFlowy

[FR] : AI Writers #2782

Description

Timeline:

Midterm Valuation

Impact

Additional Context