Hey guys! I’ve been setting up my local development environment to contribute to phoenix, following the instructions in both CONTRIBUTING.md and DEVELOPMENT.md. I've cloned the main branch in my Ubuntu WSL environment and installed the project in editable mode using:
pip install -e ".[dev]"After building the frontend (pnpm run build) and setting up a PostgreSQL database locally (exporting PHOENIX_DATABASE_URL), I tried running phoenix serve However, I encountered the following issue:
ModuleNotFoundError: No module named 'phoenix.evals' I didn't find any evals module in the src directory, but found directions about it in MIGRATION.md which mentions that evals plugin needs to be installed explicitly using:
pip install arize-phoenix[evals]Once I did that, the import worked fine. ✅ Just wanted to check: Is this the expected setup for working with main in a full development environment, or is there a recommended way to develop and test Phoenix with the evals module included locally (e.g. cloning and installing the plugin repo in editable mode)? Also, which is the best channel to discuss about contribution and oss? Thanks in advance! 🙏
Yes, the setup you followed is expected for working with the main branch of Phoenix, especially when dealing with the evals module. According to the Phoenix documentation, the evals module is an optional extra that needs to be installed separately using pip install 'arize-phoenix[evals]'. This is because phoenix.evals is packaged as a separate module, which allows it to be used independently or alongside the main Phoenix package.For developing and testing Phoenix with the evals module included locally, you can indeed clone the phoenix-evals repository and install it in editable mode. This approach allows you to make changes to the evals module and test them in your local environment. You can follow the same process as you did for the main Phoenix repository, using pip install -e . in the phoenix-evals directory.For discussions about contributions and open-source development, the best channel would be the Arize AI Slack community, where you can connect with other contributors and the core development team. You can also use the GitHub issues and pull requests for more formal discussions and feedback on specific contributions.Sources:
- Arize AI Slack Community
- Phoenix documentation
💡 Hint: Mention RunLLM in the thread for followups.
Hi Francisco P. thanks so much for thinking of contributing! When you install Phoenix locally you’ll need to run our symlink script to get our submodules installed locally
One moment I’ll get the command for you
tox run -e add_symlinks
In case this helps other starting contributors https://github.com/Arize-ai/phoenix/pull/6985