Skip to content
  • Rate limit · GitHub

    Access has been restricted

    You have triggered a rate limit.

    Please wait a few minutes before you try again;
    in some cases this may take up to an hour.

  • Notifications You must be signed in to change notification settings
  • Fork 46.5k
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[mypy] Add/fix type annotations for similarity search in machine learning #4088

Merged
merged 4 commits into from
Jan 22, 2021
Rate limit · GitHub

Access has been restricted

You have triggered a rate limit.

Please wait a few minutes before you try again;
in some cases this may take up to an hour.

Conversation

SteveKimSR
Copy link
Contributor

$ mypy --strict machine_learning/similarity_search.py --ignore-missing-imports
Success: no issues found in 1 source file

Describe your change:

Related Issue: #4052

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.
Rate limit · GitHub

Access has been restricted

You have triggered a rate limit.

Please wait a few minutes before you try again;
in some cases this may take up to an hour.

@ghost ghost added awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files labels Jan 1, 2021
Copy link
Member

@poyea poyea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your pull request!🤩

@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Jan 3, 2021
def similarity_search(dataset: np.ndarray, value_array: np.ndarray) -> list:
def similarity_search(
dataset: np.ndarray, value_array: np.ndarray
) -> List[List[float]]:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The return type hint does not seem to be correct as per the given examples:

[[[0], 0.0]]
[[[0, 0, 0], 1.0]]
[[[0, 0, 0], 0.0], [[0, 0, 0], 1.0]]

Maybe:

List[List[Union[List[float], float]]]

I would suggest changing the return data type but that is out of scope for this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :)

@ghost ghost added the awaiting changes A maintainer has requested changes to this PR label Jan 4, 2021
@ghost ghost added awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass and removed awaiting changes A maintainer has requested changes to this PR labels Jan 6, 2021
@ghost ghost removed the tests are failing Do not merge until tests pass label Jan 6, 2021
@SteveKimSR SteveKimSR requested a review from dhruvmanila January 6, 2021 17:23
Copy link
Member

@dhruvmanila dhruvmanila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the wait, I've been a bit busy. Thank you for your contribution! LGTM! 🎉

@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Jan 22, 2021
@dhruvmanila dhruvmanila merged commit d594f45 into TheAlgorithms:master Jan 22, 2021
peRFectBeliever pushed a commit to peRFectBeliever/Python that referenced this pull request Apr 1, 2021
…ning (TheAlgorithms#4088)

* [mypy] Add/fix type annotations for similarity search in machine learning

* fix annotation

* fix annotation (Union)

* isort
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
…ning (TheAlgorithms#4088)

* [mypy] Add/fix type annotations for similarity search in machine learning

* fix annotation

* fix annotation (Union)

* isort
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
…ning (TheAlgorithms#4088)

* [mypy] Add/fix type annotations for similarity search in machine learning

* fix annotation

* fix annotation (Union)

* isort
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This PR modified some existing files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rate limit · GitHub

Access has been restricted

You have triggered a rate limit.

Please wait a few minutes before you try again;
in some cases this may take up to an hour.

3 participants