https://github.com/juliasmoothoptimizers/nlpmodelstest.jl

https://github.com/juliasmoothoptimizers/nlpmodelstest.jl

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/juliasmoothoptimizers/nlpmodelstest.jl
• Owner: JuliaSmoothOptimizers
• License: other
• Created: 2021-03-12T19:24:24.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-01T23:12:56.000Z (over 1 year ago)
• Last Synced: 2025-06-03T04:38:10.348Z (about 1 year ago)
• Language: Julia
• Size: 1.93 MB
• Stars: 7
• Watchers: 3
• Forks: 3
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Citation: CITATION.cff
  • Zenodo: .zenodo.json

Awesome Lists containing this project

README

          
# NLPModelsTest

This package provides testing facilities for developers of models implementing the [NLPModels](https://github.com/JuliaSmoothOptimizers/NLPModels.jl) API.

## How to Cite

If you use NLPModelsTest.jl in your work, please cite using the format given in [CITATION.cff](https://github.com/JuliaSmoothOptimizers/NLPModelsTest.jl/blob/main/CITATION.cff).

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4603933.svg)](https://doi.org/10.5281/zenodo.4603933)

[![GitHub release](https://img.shields.io/github/release/JuliaSmoothOptimizers/NLPModelsTest.jl.svg)](https://github.com/JuliaSmoothOptimizers/NLPModelsTest.jl/releases/latest)

[![](https://img.shields.io/badge/docs-stable-3f51b5.svg)](https://JuliaSmoothOptimizers.github.io/NLPModelsTest.jl/stable)

[![](https://img.shields.io/badge/docs-latest-3f51b5.svg)](https://JuliaSmoothOptimizers.github.io/NLPModelsTest.jl/dev)

[![codecov](https://codecov.io/gh/JuliaSmoothOptimizers/NLPModelsTest.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaSmoothOptimizers/NLPModelsTest.jl)

![CI](https://github.com/JuliaSmoothOptimizers/NLPModelsTest.jl/workflows/CI/badge.svg?branch=main)

[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/JuliaSmoothOptimizers/NLPModelsTest.jl?logo=Cirrus%20CI)](https://cirrus-ci.com/github/JuliaSmoothOptimizers/NLPModelsTest.jl)

## Usage

During the development of your model, you might find the need for more robust tests.

This package provides problems and functions to that end.

The main usage of this package are the consistency checks, which runs a comparison of two or models on all API functions.

Check the [docs](https://JuliaSmoothOptimizers.github.io/NLPModelsTest.jl/dev) for the complete usage.

# Bug reports and discussions

If you think you found a bug, feel free to open an [issue](https://github.com/JuliaSmoothOptimizers/NLPModelsTest.jl/issues).

Focused suggestions and requests can also be opened as issues. Before opening a pull request, start an issue or a discussion on the topic, please.

If you want to ask a question not suited for a bug report, feel free to start a discussion [here](https://github.com/JuliaSmoothOptimizers/Organization/discussions). This forum is for general discussion about this repository and the [JuliaSmoothOptimizers](https://github.com/JuliaSmoothOptimizers), so questions about any of our packages are welcome.