Merged
Conversation
Teste de linting nos ficheiros atuais do yake
testes gerais
refatorização inicial do programa principal
criado workflow para verificar resultados
atualização resultados.yml
atualizado resultados.yml
atualizado status adicionados ficheiros originais para comparações
Removidos ficheiros originais, pois estavam a interferir com o score do teste pylint
highligths.py 90%
só falta refatorar variáveis, reconstruir métodos e documentação
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR streamlines the repository by removing legacy Docker images and demos, enhancing documentation, and adding a full CI/CD pipeline.
- Removed outdated Dockerfiles and demo scripts
- Refactored README with clearer installation, usage, and citation sections
- Introduced a Makefile and multiple GitHub Actions workflows for testing, linting, formatting, and release automation
Reviewed Changes
Copilot reviewed 155 out of 155 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docker/Dockerfiles/yake/Dockerfile | Deleted legacy Python CLI Dockerfile |
| docker/Dockerfiles/yake-server/* | Deleted old REST API server script and Dockerfile |
| demo/streamlit_app.py, demo/packages.txt | Removed demo app and its dependency list |
| README.md | Overhauled documentation, updated Quick Installation & Usage |
| Makefile | Added targets for install, test, lint, format, build, deploy |
| .python-version | Set default Python version to 3.10 |
| .github/workflows/*.yml | Added workflows: test, lint, format, install, deploy, releases |
Comments suppressed due to low confidence (2)
.github/workflows/publishpypi.yml:1
- The
namefield is wrapped in an opening quote but missing a closing quote and spans multiple lines, which is invalid YAML. Please remove the extraneous quote or properly quote the entire string on one line.
"name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
.github/workflows/createpypirelease.yml:1
- Similar to the other workflow, the
namefield is improperly quoted. Please ensure the name is either unquoted or correctly enclosed in quotes on a single line.
"name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
README.md
Outdated
Comment on lines
+17
to
+23
| uv pip install git+https://github.com/LIAAD/yake | ||
| ``` | ||
| *Example text from Wikipedia* | ||
|
|
||
| <a name="rest-api-image"></a> | ||
| ### Option 2. REST API Server in a Docker container | ||
|
|
||
| This install will provide you a mirror of the original REST API of YAKE! available [here](https://boiling-castle-88317.herokuapp.com). | ||
| or | ||
|
|
||
| ```bash | ||
| docker run -p 5000:5000 -d liaad/yake-server:latest | ||
| ``` | ||
|
|
||
| After it starts up, the container will run in the background, at http://127.0.0.1:5000. To access the YAKE! API documentation, go to http://127.0.0.1:5000/apidocs/. | ||
|
|
||
| You can test the RESTful API using `curl`: | ||
|
|
||
| ```bash | ||
| curl -X POST "http://localhost:5000/yake/" -H "accept: application/json" -H "Content-Type: application/json" \ | ||
| -d @- <<'EOF' | ||
| { | ||
| "language": "en", | ||
| "max_ngram_size": 3, | ||
| "number_of_keywords": 10, | ||
| "text": "Sources tell us that Google is acquiring Kaggle, a platform that hosts data science and machine learning competitions. Details about the transaction remain somewhat vague , but given that Google is hosting its Cloud Next conference in San Francisco this week, the official announcement could come as early as tomorrow. Reached by phone, Kaggle co-founder CEO Anthony Goldbloom declined to deny that the acquisition is happening. Google itself declined 'to comment on rumors'. Kaggle, which has about half a million data scientists on its platform, was founded by Goldbloom and Ben Hamner in 2010. The service got an early start and even though it has a few competitors like DrivenData, TopCoder and HackerRank, it has managed to stay well ahead of them by focusing on its specific niche. The service is basically the de facto home for running data science and machine learning competitions. With Kaggle, Google is buying one of the largest and most active communities for data scientists ..." | ||
| } | ||
| EOF | ||
| ``` | ||
| *Example text from Wikipedia* | ||
|
|
||
| <a name="standalone-installation"></a> | ||
| ### Option 3. Standalone Installation (for development or integration) | ||
|
|
||
| #### Requirements | ||
|
|
||
| Python3 | ||
|
|
||
| #### Installation | ||
|
|
||
| To install Yake using pip: | ||
|
|
||
| ``` bash | ||
| pip install git+https://github.com/LIAAD/yake | ||
| uv pip install yake |
There was a problem hiding this comment.
[nitpick] The prefix uv may be unclear to users unfamiliar with the Invoke CLI. Consider clarifying it (e.g., "using Invoke: uv pip install ...") or replacing with a plain pip install command if Invoke is not required.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…nto core-seperation
Collaborator
|
Yake! Refactoring by @tiagolv |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refactored code, added documentation ,updated readme, better CI/CD pipelin, new webpage with documentation and new links