Skip to content

Added doctest, docstring and typehint for sigmoid_function & cost_function #10828

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
Oct 26, 2023
Merged

Added doctest, docstring and typehint for sigmoid_function & cost_function #10828

merged 8 commits into from
Oct 26, 2023

Conversation

Suyashd999
Copy link
Contributor

Describe your change:

Contributes to #9943

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • 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 include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Oct 23, 2023
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 25, 2023
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 25, 2023
@Suyashd999 Suyashd999 changed the title Added doctest for sigmoid_function & cost_function Added doctest, docstring and typehint for sigmoid_function & cost_function Oct 25, 2023
@Suyashd999
Copy link
Contributor Author

Hey @tianyizheng02 , @cclauss , can you guys please review this PR? Thanks in advance!

cclauss
cclauss previously requested changes Oct 26, 2023
View reviewed changes
@algorithms-keeper algorithms-keeper bot added awaiting changes A maintainer has requested changes to this PR and removed awaiting reviews This PR is ready to be reviewed labels Oct 26, 2023
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed awaiting changes A maintainer has requested changes to this PR labels Oct 26, 2023
@tianyizheng02 tianyizheng02 requested a review from cclauss October 26, 2023 06:07
@Suyashd999
Copy link
Contributor Author

hey @cclauss , I made the changes that you mentioned.

tianyizheng02
tianyizheng02 approved these changes Oct 26, 2023
View reviewed changes
@tianyizheng02 tianyizheng02 dismissed cclauss’s stale review October 26, 2023 07:55

Requested changes already made

@tianyizheng02 tianyizheng02 merged commit dd7d18d into TheAlgorithms:master Oct 26, 2023
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 26, 2023
sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@Suyashd999 @tianyizheng02 @sedatguzelsemme
Added doctest, docstring and typehint for sigmoid_function & cost_fun…
2461a84 
…ction (TheAlgorithms#10828)

* Added doctest for sigmoid_function & cost_function

* Update logistic_regression.py

* Update logistic_regression.py

* Minor formatting changes in doctests

* Apply suggestions from code review

* Made requested changes in logistic_regression.py

* Apply suggestions from code review

---------

Co-authored-by: Tianyi Zheng <tianyizheng02@gmail.com>
@isidroas isidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@imSanko imSanko imSanko left review comments

@AasheeshLikePanner AasheeshLikePanner AasheeshLikePanner left review comments

@tianyizheng02 tianyizheng02 tianyizheng02 approved these changes

@cclauss cclauss Awaiting requested review from cclauss

Assignees
No one assigned
Labels
enhancement This PR modified some existing files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Suyashd999 @cclauss @tianyizheng02 @imSanko @AasheeshLikePanner