Mercelisvaughan model 1 #2

mercelisvaughan · 2024-04-15T23:15:48Z

This is a pull request for the sample. This pull request is

Adding unit tests for the RevertRiskAPIModel class.
Fixing a bug in the request_to_revertRiskAPI method. (I still have to get the bug, I return a 404 for some reason, I need to return 200 and the response)

… and added type hints to function

…PI that accepts a string for language and an integer for revision id, it will make the request and return the json response

…dded validation for response and unit test package

… to .gitignore

isaranto

Nice work getting started! You can add a more descriptive Pull request title. This will end up being a commit in our git history so it is good to have a title that makes sense when looking at commands like git log

isaranto · 2024-04-16T16:41:52Z

src/liftwing_api/models/liftwing_model.py

+        # this method will make a request and return a json response
+        #return response.json()
+        return ""


If we create an abstract class we can just issue a pass directive.

Suggested change

# this method will make a request and return a json response

#return response.json()

return ""

pass

I completed the method

isaranto · 2024-04-18T14:13:40Z

README.md

@@ -4,3 +4,43 @@
 This is a Python package that acts as a client and allows users to make requests to the LiftWing API.
 Its purpose is to allow users to interact with the API by writing python code instead of manipulating HTTP requests.

+Below is an example of how to make a request. This specific request is being made to the revert_risk API


We should remove the code from the README file as this file serves as our basic documentation. A user might only be interested on how to use the package rather than deep dive from the start on what is does behind the hood.

After we publish the package we can include an example of how to use it.

I have removed the code

isaranto · 2024-04-18T14:43:44Z

src/liftwing_api/models/revertrisk.py

+from liftwing_model import LiftwingModel
+
+class RevertRiskAPIModel(LiftwingModel):
+    def __init__(self, base_url="https://api.wikimedia.org/service/lw/inference/v1/models/{language}-reverted:predict"):


This is not the url for the revertrisk model

"https://api.wikimedia.org/service/lw/inference/v1/models/{language}-reverted:predict"

This is the link to the relevant documentation for the revertrisk language agnostic model
https://api.wikimedia.org/wiki/Lift_Wing_API/Reference/Get_reverted_risk_language_agnostic_prediction

corrected the url

isaranto · 2024-04-18T14:55:37Z

src/liftwing_api/models/revertrisk.py

+import json
+from liftwing_model import LiftwingModel
+
+class RevertRiskAPIModel(LiftwingModel):


It is a good idea to keep only as base url the first part of the string
https://api.wikimedia.org/service/lw/inference/v1/models/
and the latter part will be the one specific to the model and can be hardcoded for now.

isaranto · 2024-04-18T14:57:40Z

src/liftwing_api/models/revertrisk.py

+from liftwing_model import LiftwingModel
+
+class RevertRiskAPIModel(LiftwingModel):
+    def __init__(self, base_url="https://api.wikimedia.org/service/lw/inference/v1/models/{language}-reverted:predict"):


It is a good idea to keep only as base url the first part of the string
https://api.wikimedia.org/service/lw/inference/v1/models/
and the latter part will be the one specific to the model and can be hardcoded for now like this:

self.model_name = "revertrisk-language-agnostic" self.url = f"{base_url}{self.model_name}:predict"

isaranto · 2024-04-18T15:00:06Z

src/liftwing_api/models/liftwing_model.py

@@ -0,0 +1,12 @@
+import requests
+
+class LiftwingModel:


This can be an abstract class and the request method can be an abstractmethod that has the following arguments:

payload : dict

method :str ="POST"

headers : dict

lets talk about the methods I added

isaranto · 2024-04-25T13:28:50Z

.vscode/settings.json

@@ -0,0 +1,5 @@
+{


This file should be deleted. Since we added it in the .gitignore fiel it also won't be committed automatically in the future

isaranto · 2024-04-25T14:00:24Z

pyproject.toml

@@ -0,0 +1,12 @@
+[tool.poetry]


This configuration for poetry is incomplete and throws an error when trying to run pip install -e .

File "/private/var/folders/0d/x7f69d5s525d0pn0gp8cyrzr0000gn/T/pip-build-env-46zwyrnz/overlay/lib/python3.11/site-packages/poetry/core/factory.py", line 60, in create_poetry raise RuntimeError("The Poetry configuration is invalid:\n" + message) RuntimeError: The Poetry configuration is invalid: - The fields ['authors'] are required in package mode. [end of output]

However I would suggest to use the more generic [project] section instead of the poetry specific ones as described in the documentation (related PEP documentation)
It seems to be a future proof standard for python and poetry is going to adopt that as well as seen in its roadmap (related poetry PR).
Let me know if you need any help on this!

isaranto · 2024-05-08T12:51:46Z

pyproject.toml

+dependencies = [
+    "requests",
+]
+dynamic = ["version"]


In order for package installation to work (e.g. pip install -e . this line should be removed:
We use a dynamic version when the version number isn't declared in this file but extracted from somewhere else.
In our case we define the version field so if we set both we would get an error.

WMF2906 and others added 13 commits March 25, 2024 15:55

added examples folder, changed examples.py to revertrisk_examples.py,…

81479ef

… and added type hints to function

Update README.md

788689a

Add files via upload

c1260f5

a function that will make a request to revertrisk language agnostic A…

f58bfab

…PI that accepts a string for language and an integer for revision id, it will make the request and return the json response

Update README.md with longer explanation

6740d3f

added examples dir, renamed file, added more function arguments and a…

cb99e1c

…dded validation for response and unit test package

added extra test

82d2e0a

corrected 2 junit tests

57c8a37

added .toml and src package, added one unit test

642e85b

updated .toml file, added models package, added .vscode and .ds_store…

f8fa514

… to .gitignore

added basemodel and revertrisk api

21a5235

added changes to base_api_model

2a7519a

changed basemodelapi to liftwing api and added new test package

da1c502

mercelisvaughan requested a review from isaranto April 15, 2024 23:15

mercelisvaughan changed the base branch from main to mercelisvaughan-patch-1 April 15, 2024 23:16

WMF2906 added 2 commits April 16, 2024 10:23

fixed 404 bug by changing language

21db421

added langid.py,readability.py, and revscoring, added more descriptions

d199450

isaranto requested changes Apr 18, 2024

View reviewed changes

isaranto changed the base branch from mercelisvaughan-patch-1 to main April 25, 2024 13:21

isaranto changed the base branch from main to mercelisvaughan-patch-1 April 25, 2024 13:22

isaranto changed the base branch from mercelisvaughan-patch-1 to main April 25, 2024 13:22

isaranto reviewed Apr 25, 2024

View reviewed changes

pyproject toml does not work

29243b4

isaranto reviewed May 8, 2024

View reviewed changes

added request functions to all child classes

88f089d

isaranto closed this Jun 12, 2024

isaranto deleted the mercelisvaughan-model-1 branch July 2, 2024 10:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mercelisvaughan model 1 #2

Mercelisvaughan model 1 #2

mercelisvaughan commented Apr 15, 2024

isaranto left a comment

isaranto Apr 16, 2024

mercelisvaughan Apr 25, 2024

isaranto Apr 18, 2024

mercelisvaughan Apr 25, 2024

isaranto Apr 18, 2024

mercelisvaughan Apr 25, 2024

isaranto Apr 18, 2024

isaranto Apr 18, 2024

isaranto Apr 18, 2024

mercelisvaughan Apr 25, 2024

isaranto Apr 25, 2024

mercelisvaughan Apr 25, 2024

isaranto Apr 25, 2024

isaranto May 8, 2024

Mercelisvaughan model 1 #2

Mercelisvaughan model 1 #2

Conversation

mercelisvaughan commented Apr 15, 2024

isaranto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment