Skip to main content

Mathematical proof assistant for students and amateurs.

Project description

proofs

This is a proofs validator to help students and hobbyists do mathematical thinking and problem solving.

It’s for when you buy a math book from the local used book store, so you have a piece of software to use to explore the mathematical concepts alongside you that’s fun and easy to use for anybody with a programming background.

It’s supposed to validate what you’re doing in a “black box” kind of manner, and try to offer you guardrails enough that you can spot your mistakes and feel reasonably more confident you know what you’re doing.

Not perfectly confident, reasonably.

Features:

  • human-readable proofs that run in code. Clear from each line what is being achieved mathematically.
  • Pure python. Duck typing and abstracts allow for quick end-to-end proof designs, only implementing what you need.
  • Relies on python abstractions you know, like the type system for defining input and output types
  • Great, human readable errors so it’s clear where your logic is breaking down, why, how you might fix it.

Principles

  • Minimal abstractions, small API
  • minimal dependencies (just sympy right now)
  • declarative, functional api
  • simple to use
  • batteries included

Install

pip install proofs

How to use

Let’s start with something simple, first, let’s prove that “Given x, Assume x + 1 = x is false for all x”

This should be obvious, which makes is great to show how to approach a proof.

  1. Define the problem
  2. Look at examples
  3. Decide on a proof strategy
  4. Write the proof
# Start by defining your domain
arbitrary_x = variable("x")
expression = arbitrary_x + 1
print(expression)
x + 1
# select a few examples from the reals
make_examples('real', 3, expression)
[(-92, -91), (59, 60), (80, 81)]

Hopefully these examples convice us that the statement is false. This suggests that we can prove it by contradiction.

# Then define your goal
contradiction_goal = not_equals(expression, arbitrary_x)
@contradiction_proof
def proof_of_x_plus_one(x):
    # Given x, Assume x + 1 = x is true for arbitrary_x
    assumed_eq = equals(x + 1, x)

    # Calculate x + 1
    next = x + 1

    # Observing x + 1 $\neq$ x, we have reached a contradiction
    return not_equals(next, assumed_eq.rhs)

#Select an arbitrary x from the domain
prove(contradiction_goal, proof_of_x_plus_one, arbitrary_x)
<IPython.core.display.Latex object>

$$x + 1 = x$$

<IPython.core.display.Latex object>

$$x + 1$$

<IPython.core.display.Latex object>

$$\text \quad x + 1 \neq x \quad Q.E.D.$$

True

With this, we get: 1. comments converted to latex, along with latex rendering of the math we are doing in python 2. validation that what we are returning from the proof matches the expected goal 3. some additional helpful errors

Next steps

Likes:

  • simple API

  • structure is about proving things now

  • Like that the goal is to create a prove function that matches the goal given the input you have. I think that’s very straightforward.

Dislikes

  • type system not doing anything. Can we use mypy or isinstance to actually check that the correct type is being returned?

  • no error handling to help detect where the proof is going wrong. should provide better error messages than just AttributeError: 'BooleanFalse' object has no attribute 'lhs' — why is that a booleanFalse object? what else might I want to try? Also needs to be build into library, not user defined all the time

Must haves:

  • Needs to be clearer that the flow is to generate a proof spec, decide on an input, and then generate a proof function to do this. Solve this by providing a function that helps do common problem setups, and prints them as Latex, then outputs something that can be used in the _proof strategy decorators.

Feature requests:

  • I really want simple, composable visualization features. It will be really much more interesting if we can see visually what is happening – see start below https://docs.manim.community/en/stable/examples.html#animations

  • build in a simple type unification feature. see research on [[proofs - inductive types and unification]]

  • better latex printing

nice to haves

  • some common ‘tactics’ mirroring lean; rewrite, reflexivity, etc. Pull from sympy as well
  • integrate hypothesis to show that the

Content:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

proofs-0.0.1.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

proofs-0.0.1-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file proofs-0.0.1.tar.gz.

File metadata

  • Download URL: proofs-0.0.1.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.13

File hashes

Hashes for proofs-0.0.1.tar.gz
Algorithm Hash digest
SHA256 01aa422fd59207fd2a8685f65e38f5cbbd447d8a24d9dbfb16c49acb5c0f9142
MD5 5e405e949656a4b4dd8dd7b3474b15f0
BLAKE2b-256 39b9a2e4aabd1e8f5f177e583d0d381097d2bca56ab21c84d04d6644af69b2d4

See more details on using hashes here.

File details

Details for the file proofs-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: proofs-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.13

File hashes

Hashes for proofs-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0b36b18efadacd3da68eaeb0e2e03d822a463255a17ceccec71d086e7b604e81
MD5 4503f7a144d0f6535c104401dc53db54
BLAKE2b-256 dd1b274804a670efb28329589ca99ba703d58479048f2da36ebd6df527cbfe00

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page