Skip to content

Update README.md with CI/CD Information and Feature Status #15

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

Merged
merged 1 commit into from
Jun 7, 2025

Conversation

Advaitgaur004
Copy link
Contributor

This pull request brings several updates to README.md to better reflect the current status and development practices of the cTensor project.

Key Changes Proposed:

  • Added "Continuous Integration" Section:

    • Details the newly implemented GitHub Actions workflows for:
    • Automated building and testing across multiple platforms (Linux, macOS, Windows) via run-ctests.yml.
    • Verification of test results using check_all_results.py.
    • Operator test coverage checks via check-operator-test-coverage.yml to ensure all tensor operators have corresponding tests.
    • This section highlights the project's commitment to code quality and automated checks.
  • Updated "Testing the Library" Section:

    • Ensured testing instructions are accurate, including the correct name for the test executable (e.g., cten_tests or cten_tests.exe as built by CMake).
  • Refreshed "Features" List:

    • Reviewed and updated the "Currently Implemented" and "Development Roadmap" sections.
    • Moved recently implemented features from the roadmap to the implemented list.
    • Ensured the list of tensor operations and neural network components accurately reflects the library's current capabilities.
  • General Enhancements:

    • Minor improvements to clarity, formatting, and accuracy throughout the document.

These updates aim to provide developers and users with a more comprehensive and up-to-date overview of the cTensor library, its features, and its development infrastructure.

@PrimedErwin PrimedErwin merged commit 02d3a30 into pocketpy:main Jun 7, 2025
@Advaitgaur004 Advaitgaur004 deleted the readme branch June 7, 2025 16:01
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.

None yet

2 participants