- Description
- Features
- Interactive Demo
- Setup and Installation
- Usage
- Project Structure
- Acknowledgments
- Known Issues
- Contributing
- License
- Disclaimer
TFT Embedded Synergy Builder is a recommendation system designed for Teamfight Tactics (TFT). Leveraging semantic-based search and embeddings, it offers personalized suggestions for optimal champions and items based on your selected champions. By computing the average embedding of chosen champions, the system identifies synergistic champions to enhance your team composition.
This project investigates the effectiveness of semantic search techniques in generating champion and item recommendations, aiming to assist players in strategizing and optimizing their gameplay.
- Personalized Recommendations: Tailored suggestions for champions and items based on your selections.
- Semantic Search: Utilizes embeddings to understand champion relationships and synergies.
- Interactive Interface: User-friendly interface built with Streamlit for seamless interaction.
- Real-time Suggestions: Instantaneous recommendations as you select your champions.
Experience the application firsthand! Click the badge below to launch the live demo.
Follow these steps to set up the project locally:
- Python 3.8 or higher
- Pipenv: Python dependency manager.
If you don't have Pipenv installed, install it using pip:
pip install pipenv
-
Clone the Repository
git clone https://github.com/neo-con/tft-embedded-synergy-builder.git
-
Navigate to the Project Directory
cd tft-embedded-synergy-builder
-
Install Dependencies
Use Pipenv to install project dependencies:
pipenv install
-
Activate the Pipenv Shell
pipenv shell
-
Run the Application
Launch the Streamlit app:
streamlit run app.py
The application should now be accessible at
http://localhost:8501
.
-
Select Your Champion(s):
Enter your chosen champion(s) into the input text box. You can input multiple champions separated by commas.
-
Receive Recommendations:
The system will generate a recommended team composition based on the embeddings and synergies of your selected champions.
-
Explore Suggested Items:
Along with champion recommendations, optimal items for your team will be suggested to enhance performance.
- FAISS by Facebook Research: For providing efficient similarity search and clustering of dense vectors.
- OpenAI Embedding API: For powering the semantic search capabilities.
- Mobile Responsiveness: The layout on mobile devices is suboptimal due to limited responsiveness controls in Streamlit. Plans to migrate to more flexible frameworks like Django, Flask, or React are underway to address this limitation.
Contributions are welcome! Please follow these steps:
-
Fork the Repository
-
Create a Feature Branch
git checkout -b feature/YourFeature
-
Commit Your Changes
git commit -m "Add your feature"
-
Push to the Branch
git push origin feature/YourFeature
-
Open a Pull Request
Please ensure your contributions adhere to the project's coding standards and include relevant tests.
This project is licensed under the MIT License. You are free to use, modify, and distribute the code, provided that proper credit is given.
Note: This project is not affiliated with or endorsed by the creators of Teamfight Tactics or Riot Games. All game images, names, and other details are property of their respective owners.