[DMP 2025]: Standardizing and Enhancing the Feluda Python Packages

[aatmanvaidya]

Description

Feluda is a configurable engine for analyzing multi-lingual and multi-modal content. It allows researchers, factcheckers and journalists to explore and analyze large quantity of multimedia content. Feluda has a component called operators , which are built keeping in mind the need to process data in various modalities (text, audio, video, images, hybrid) and various languages. Each operator is a python package, and we have a monorepo with a multi-package system. As Feluda continues to grow, ensuring consistency and robustness across these packages is crucial for long-term maintainability and ease of contribution.
The goal of the project is to improve the internal structure of Feluda packages, enhance documentation, and optimize performance, laying the groundwork for a stable v1.0.0 release.

Goals

• Standardize interfaces and functions across all Feluda Python packages.
• Write comprehensive documentation for all packages.
• Achieve close to 100% test coverage with unit and integration tests.
• Enhance package build robustness and integration capabilities with other applications.
• Create practical tutorials (jupyter notebooks) and use cases for fact-checkers and researchers.

Expected Outcome

• Consistent APIs across all packages with standardized functions
• Basic documentation hosted on Read the Docs covering package functionality, input/output formats, and detailed use cases.
• Improved error handling with clear, actionable messages for the user
• A collection of tutorials and notebooks demonstrating real-world applications like extracting text from newspaper images, clustering large amounts of video to detect social thematic labels etc
• Expanded test coverage for better reliability

Acceptance Criteria

• Write Tests to validate compliance for current feluda operators
• Write documentation and python notebooks to demonstrate use of current operators
• Participate in weekly update calls and demonstrate progress

Implementation Details

1. Standardization:
   • Define a common interface (API) for all packages with init() and run() functions.
   • Implement proper error handling and warnings
   • Ensure feluda raises exceptions when working with incompatible operators
2. Documentation:
   • Create a Read the Docs template covering each package's purpose, function signatures, expected inputs/outputs, and common use cases.
   • Develop example notebooks (Google Colab/Marimo) showcasing practical applications for researchers and fact-checkers.
3. Robustness:
   • Optimize model loading processes to reduce memory footprint and improve runtime efficiency.
4. Testing:
   • Expand test coverage to include integration tests across packages.
   • Implement CI GitHub Action pipelines to run tests and other safety checks.

Product Name

Feluda

Organisation Name

Tattle

Domain

Open Source Library

Tech Skills Needed

Python, Object-Oriented Programming, Machine Learning, Performance Improvement, Docker, Testing, Technical Writing.

Mentor

Denny George (@dennyabrain ), Aatman Vaidya (@aatmanvaidya )

Category

Data Science, Machine Learning

[pranjalipilankar]

Hello, I am interested to work on this task under DMP 2025. Please assign it to me.

[harshit-G51102]

hi, i am interested, can you assign this issue to me?

[uniabhi]

Hello, I am interested to work on this task under DMP 2025. Please assign it to me.

[aatmanvaidya]

Hello everyone,

Thank you so much for your interest in contributing!

Since this is the main C4GT DMP'25 issue, we will be following the official selection process, wherein, interested contributors need to submit their proposals for the project, and shortlisting is done based on that. As a result, we won’t be assigning this particular issue to anyone directly at this stage.

In the meantime, please check out the list of open/ good first issues!

[AnkitaWaghode25]

Hi, I’m Ankita, a BTech student with knowledge of Python, OOP, and ML concepts. I’m new to open-source but eager to contribute. I’ve explored the Feluda repo and want to help with testing, documentation, or improving operators. Could you please guide me toward a good first issue or beginner-friendly task?

[dikshant182004]

hi @aatmanvaidya ,this side dikshant jha .I want to contribute in dmp2025 , I will start by making me more comfortable with this repo and try to solve some good issues .Looking forward to your guidance and support 😊!!!

[blenbot]

Hey @aatmanvaidya, do we have any communication channels(slack, discord, matrix) to interact with mentors?

[aatmanvaidya]

hi @blenbot here is the link to join our slack, there is a channel called #feluda where DMP related things can be discussed.

[blenbot]

hi @blenbot here is the link to join our slack, there is a channel called #feluda where DMP related things can be discussed.

Thanks again!

[Shyanil]

Hi, @aatmanvaidya , @dennyabrain I'm Shyanil Mishra, an Automation Developer Trainee at SquashCode. I’m excited to contribute to Feluda and would love to start by fixing a good first issue!

[aatmanvaidya]

Hello everyone, thank you for your interest, If you are planning to submit a proposal to work on feluda for the C4GT DMP'25 program, we have noted down some helpful pointers in this discussion - #613

We can use this discussion space for any questions you would have about the DMP issue or anything you would want to discuss about the proposal

[sparrowjack234]

Hi @aatmanvaidya, I'm Suyash, and I'm really interested in this project. I'd love to contribute and work on it.