Feat/nnlm model implementation #3

shenxiangzhuang · 2025-01-23T08:15:13Z

Summary by CodeRabbit

Release Notes

New Features
- Added Neural Network Language Model (NNLM) implementation.
- Introduced dataset loading for NNLM training using Salesforce/wikitext dataset.
- Added functionality for device management to determine computation device (GPU/CPU).
- Implemented a tokenizer class for managing tokenization processes.
Dependencies
- Updated Python version support to 3.13.
- Added new project dependencies: datasets, numpy, tokenizers, torch, and wandb.
- Removed Python version 3.12 from project specifications.
Documentation
- Updated NNLM README with sections for dataset preparation, tokenizer training, and model training.
- Introduced a new Jupyter Notebook for loading and processing the Wikitext dataset.
Chores
- Modified GitHub Actions workflow test configuration.
- Updated GitHub Actions workflow for building documentation.
- Enhanced .gitignore to exclude model artifacts and logging files.
Removals
- Removed hello() function and associated test file from the project.
- Eliminated Flake8 configuration from pre-commit hooks.

coderabbitai · 2025-01-23T08:15:20Z

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces several changes to the project, focusing on the configuration of workflows, dependencies, and the implementation of a Neural Network Language Model (NNLM). Key modifications include updating the GitHub Actions workflows for testing and documentation, reducing supported Python versions, and adding new dependencies for machine learning libraries. Additionally, a new NNLM class and tokenizer management functionalities have been implemented, enhancing the project's capabilities in natural language processing.

Changes

File	Changes
`.github/workflows/test.yaml`	Reduced supported Python versions from five to four; limited OS to `ubuntu-latest`; changed coverage failure threshold from 90 to 0
`.python-version`	Removed Python version 3.12
`pyproject.toml`	Added dependencies: `datasets`, `numpy`, `tokenizers`, `torch`, `wandb`; added optional dev dependencies: `jupyterlab`, `ipywidgets`; added new `tool.uv` configuration
`toynlp/hello.py`	Removed `hello()` function
`toynlp/nnlm/README.md`	Added new NNLM section with subsections for dataset preparation, tokenizer training, and model training
`toynlp/nnlm/model.py`	Added `NNLM` class implementing Neural Network Language Model
`toynlp/nnlm/train.py`	Added `NNLMTrainer` class for training logic and utility functions for data loading and training
`.github/workflows/build_docs.yaml`	Removed several Python versions and OS options, retaining only Python 3.13 and `ubuntu-latest`
`.gitignore`	Added entries to ignore model files, wandb logs, and a specific lock file
`.pre-commit-config.yaml`	Commented out Flake8 repository configuration
`playground/nnlm/dataset.ipynb`	Introduced a Jupyter Notebook for loading and processing the Wikitext dataset
`tests/test_hello.py`	Removed test file for the `hello()` function
`tests/test_nnlm.py`	Added test function for validating `NNLM` model architecture
`toynlp/device.py`	Added `get_device()` function to determine computation device
`toynlp/nnlm/config.py`	Introduced configuration classes for various settings in the NNLM
`toynlp/nnlm/inference.py`	Added `evaluate_prompt` function for model inference
`toynlp/nnlm/tokenizer.py`	Added `NNLMTokenizer` class for managing tokenization

Possibly related PRs

Feat/nnlm model implementation #3: The changes in the main PR and the retrieved PR are related as both modify the GitHub Actions workflow configuration for testing, specifically altering the coverage failure threshold from 90 to 0.

Poem

🐰 A Rabbit's Ode to Neural Tongues 🧠
In Python's realm, version thirteen leaps,
Torch and datasets, our model now keeps
Wikitext whispers, tokens take flight
NNLM dancing with algorithmic might
Code evolves, a linguistic delight!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c138de9 and b2fd5b5.

⛔ Files ignored due to path filters (1)

uv.lock is excluded by !**/*.lock

📒 Files selected for processing (16)

.github/workflows/build_docs.yaml (0 hunks)
.github/workflows/test.yaml (2 hunks)
.gitignore (1 hunks)
.pre-commit-config.yaml (1 hunks)
.python-version (1 hunks)
playground/nnlm/dataset.ipynb (1 hunks)
pyproject.toml (3 hunks)
tests/test_hello.py (0 hunks)
tests/test_nnlm.py (1 hunks)
toynlp/device.py (1 hunks)
toynlp/nnlm/README.md (1 hunks)
toynlp/nnlm/config.py (1 hunks)
toynlp/nnlm/inference.py (1 hunks)
toynlp/nnlm/model.py (1 hunks)
toynlp/nnlm/tokenizer.py (1 hunks)
toynlp/nnlm/train.py (1 hunks)

✨ Finishing Touches

📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 7

🧹 Nitpick comments (1)

toynlp/nnlm/model.py (1)

41-54: Move test code to proper test file.

The test code in __main__ block should be moved to a proper test file with comprehensive test cases.

Create a new file tests/test_nnlm.py with proper test cases:

import pytest
import torch
from toynlp.nnlm.model import NNLM

def test_nnlm_initialization():
    model = NNLM(seq_len=6, vocab_size=1000, embedding_dim=100, hidden_dim=60)
    assert isinstance(model, NNLM)
    
def test_nnlm_forward():
    model = NNLM(seq_len=6, vocab_size=1000)
    tokens = torch.randint(0, 1000, (2, 5))
    output = model(tokens)
    assert output.shape == (2, 1000)
    assert torch.allclose(output.sum(dim=-1), torch.ones(2))

def test_nnlm_invalid_input():
    model = NNLM()
    with pytest.raises(ValueError):
        model(torch.randint(0, 1000, (2, 2, 5)))  # 3D input

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bf6ed5b and c138de9.

⛔ Files ignored due to path filters (1)

uv.lock is excluded by !**/*.lock

📒 Files selected for processing (7)

.github/workflows/test.yaml (1 hunks)
.python-version (1 hunks)
pyproject.toml (2 hunks)
toynlp/hello.py (0 hunks)
toynlp/nnlm/README.md (1 hunks)
toynlp/nnlm/model.py (1 hunks)
toynlp/nnlm/train.py (1 hunks)

💤 Files with no reviewable changes (1)

toynlp/hello.py

✅ Files skipped from review due to trivial changes (2)

.python-version
toynlp/nnlm/README.md

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: ci (3.13, windows-latest)

toynlp/nnlm/train.py

toynlp/nnlm/model.py

.github/workflows/test.yaml

pyproject.toml

codecov · 2025-02-04T09:06:38Z

Codecov Report

Attention: Patch coverage is 47.96380% with 115 lines in your changes missing coverage. Please review.

Project coverage is 47.96%. Comparing base (bf6ed5b) to head (b2fd5b5).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
toynlp/nnlm/train.py	27.63%	55 Missing ⚠️
toynlp/nnlm/tokenizer.py	38.23%	21 Missing ⚠️
toynlp/nnlm/config.py	70.58%	15 Missing ⚠️
toynlp/nnlm/model.py	66.66%	13 Missing ⚠️
toynlp/nnlm/inference.py	35.29%	11 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##            master       #3       +/-   ##
============================================
- Coverage   100.00%   47.96%   -52.04%     
============================================
  Files            1        6        +5     
  Lines            2      221      +219     
============================================
+ Hits             2      106      +104     
- Misses           0      115      +115

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

shenxiangzhuang · 2025-08-08T03:27:37Z

Close shenxiangzhuang/shenxiangzhuang.github.io#247

shenxiangzhuang added 5 commits January 23, 2025 11:01

wip

28f597d

add: torch

1cf3c7b

nnlm: network

78e1a12

reorg

31e4a61

seperate model and train

c138de9

shenxiangzhuang self-assigned this Jan 23, 2025

shenxiangzhuang marked this pull request as draft January 23, 2025 08:15

coderabbitai bot reviewed Jan 23, 2025

View reviewed changes

clean test env

a45777e

ai-glimpse deleted a comment from coderabbitai bot Feb 3, 2025

shenxiangzhuang added 7 commits February 3, 2025 19:55

clean up

68a45e8

train tokenizer

6a10adf

training

900b718

disable flake8

54f7f7b

ppl: 200+

0a07502

add: dropout

f890b4c

more epoch without direct connection

a375c4f

shenxiangzhuang added 6 commits February 4, 2025 17:42

polish

0361193

fix: model

c7ee06d

fix: model setting

5cdf28b

improve: config

1bcdaf1

fix: model implementation

c4f2450

fix: disable dropout in training configuration

b2fd5b5

shenxiangzhuang marked this pull request as ready for review February 12, 2025 14:36

shenxiangzhuang merged commit 0f8105f into master Feb 12, 2025
6 of 9 checks passed

shenxiangzhuang deleted the feat/nnlm_model_implementation branch February 12, 2025 14:36

coderabbitai bot mentioned this pull request Feb 12, 2025

Docs/add nnlm docs #5

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/nnlm model implementation #3

Feat/nnlm model implementation #3

Uh oh!

shenxiangzhuang commented Jan 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 23, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Feb 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

shenxiangzhuang commented Aug 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Feat/nnlm model implementation #3

Feat/nnlm model implementation #3

Uh oh!

Conversation

shenxiangzhuang commented Jan 23, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

coderabbitai bot commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Feb 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

shenxiangzhuang commented Aug 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

shenxiangzhuang commented Jan 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Feb 4, 2025 •

edited

Loading