Skip to content

docs: update README#167

Merged
lipikaramaswamy merged 1 commit into
mainfrom
lipikaramaswamy/docs/add-pip-install
May 21, 2026
Merged

docs: update README#167
lipikaramaswamy merged 1 commit into
mainfrom
lipikaramaswamy/docs/add-pip-install

Conversation

@lipikaramaswamy
Copy link
Copy Markdown
Collaborator

Summary

Add pip install instructions to README.

@lipikaramaswamy lipikaramaswamy requested a review from a team as a code owner May 21, 2026 13:18
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 21, 2026

Greptile Summary

This PR adds a pip install nemo-anonymizer code block to the Quick Start section of the README, giving users a direct install option before the existing "install from source" path. The package name matches the name field in pyproject.toml.

  • The new pip install block is placed correctly at the top of the Install step, with the existing git clone flow relabeled as "Or install from source:".
  • A trailing space is present at the end of the "Or install from source: " line (line 24), which is harmless but can be cleaned up.

Confidence Score: 5/5

Documentation-only change adding pip install instructions; the package name is verified against pyproject.toml and the change is self-contained.

The change is a small README addition. The pip package name nemo-anonymizer matches the project's pyproject.toml, and the new block is correctly inserted before the existing source-install path. No code is affected.

No files require special attention.

Important Files Changed

Filename Overview
README.md Adds pip install instructions before the existing source-install block; package name matches pyproject.toml. Minor trailing whitespace on the "Or install from source:" line.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User wants to install NeMo Anonymizer] --> B{Install method?}
    B -->|Quick install| C["pip install nemo-anonymizer"]
    B -->|Install from source| D["git clone https://github.com/NVIDIA-NeMo/Anonymizer.git"]
    D --> E["cd Anonymizer && make install"]
    C --> F[Set up NVIDIA_API_KEY]
    E --> F
    F --> G[Run anonymizer CLI or Python API]
Loading

Reviews (1): Last reviewed commit: "add pip install" | Re-trigger Greptile

Comment thread README.md
```bash
pip install nemo-anonymizer
```
Or install from source:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Trailing whitespace after the colon — worth removing to keep the file clean.

Suggested change
Or install from source:
Or install from source:

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@lipikaramaswamy lipikaramaswamy merged commit 91a9f08 into main May 21, 2026
8 checks passed
@lipikaramaswamy lipikaramaswamy deleted the lipikaramaswamy/docs/add-pip-install branch May 21, 2026 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant