Skip to content

Commit

Permalink
DOC Fix README.md link (Azure#319)
Browse files Browse the repository at this point in the history
  • Loading branch information
romanlutz authored Aug 8, 2024
1 parent ce2d01b commit 77968be
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 26 deletions.
10 changes: 7 additions & 3 deletions .github/check_links.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,13 @@ def resolve_relative_url(base_path, url):


def check_url(url):
if os.path.isfile(url) or os.path.isdir(url):
return url, True
if url.startswith("mailto:"):
if (
"http://localhost:" in url
or url in ["https://cognitiveservices.azure.com/.default", "https://gandalf.lakera.ai/api/send-message"]
or os.path.isfile(url)
or os.path.isdir(url)
or url.startswith("mailto:")
):
return url, True
try:
response = requests.head(url, allow_redirects=True, timeout=5)
Expand Down
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ repos:
name: Check Links in Python and md Files
entry: python ./.github/check_links.py
language: python
files: ^doc/.*\.(py|md)$
files: ^.*\.(py|md)$
additional_dependencies: ['requests']
exclude: (release_process.md|git.md|^doc/deployment/)
exclude: (release_process.md|git.md|^doc/deployment/|tests|pyrit/prompt_converter/morse_converter.py|.github|pyrit/prompt_converter/emoji_converter.py|pyrit/score/markdown_injection.py|pyrit/datasets/fetch_example_datasets.py)

- repo: https://github.com/pycqa/pylint
rev: v3.0.3
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Microsoft Learn has a
Check out our [docs](https://github.com/Azure/PyRIT/blob/main/doc/README.md) for more information
on how to [install PyRIT](https://github.com/Azure/PyRIT/blob/main/doc/setup/install_pyrit.md),
our [How to Guide](https://github.com/Azure/PyRIT/blob/main/doc/how_to_guide.ipynb),
and more, as well as our [demos](https://github.com/Azure/PyRIT/tree/main/doc/demo) folder.
and more, as well as our [demos](https://github.com/Azure/PyRIT/tree/main/doc/code).

## Trademarks

Expand Down
22 changes: 4 additions & 18 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,11 @@
# TODO: The maintainer of this repo has not yet edited this file

**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?

- **No CSS support:** Fill out this template with information about how to file issues and get help.
- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.

*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*

# Support

## How to file issues and get help

This project uses GitHub Issues to track bugs and feature requests. Please search the existing
issues before filing new issues to avoid duplicates. For new issues, file your bug or
feature request as a new Issue.

For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
This project uses GitHub Issues to track bugs, feature requests, and other questions.
Please search the existing issues before filing new issues to avoid duplicates.
For new issues, file your bug or feature request as a new issue.

## Microsoft Support Policy

Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
Support for this project is limited to the resources listed above.
2 changes: 1 addition & 1 deletion pyrit/common/inference.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def text_to_prompt_response(
Convert a text response to a proper PromptResponse object.
This is a wrapper around the OpenAI text completion object so that our code conforms to their API response.
See https://platform.openai.com/docs/guides/completion/introduction for more info
See https://platform.openai.com/docs/guides/completions for more info
Args:
text: The text contained in the response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ def __init__(
Defaults to the AZURE_OPENAI_CHAT_KEY environment variable.
use_aad_auth (bool, optional): When set to True, user authentication is used
instead of API Key. DefaultAzureCredential is taken for
https://cognitiveservices.azure.com/.default. Please run `az login` locally
https://cognitiveservices.azure.com/.default . Please run `az login` locally
to leverage user AuthN.
memory (MemoryInterface, optional): An instance of the MemoryInterface class
for storing conversation history. Defaults to None.
Expand Down

0 comments on commit 77968be

Please sign in to comment.